Skip to content

Commit 1775dd1

Browse files
authored
Add ReadTheDocs CI (#5456)
1 parent 6972695 commit 1775dd1

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

Diff for: .github/workflows/docs.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: ReadTheDocs CI
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- release/*
8+
paths:
9+
- 'docs/**'
10+
- '.github/workflows/docs.yml'
11+
pull_request:
12+
paths:
13+
- 'docs/**'
14+
- '.github/workflows/docs.yml'
15+
16+
jobs:
17+
18+
build-docs:
19+
name: Build ReadTheDocs
20+
runs-on: ubuntu-latest
21+
defaults:
22+
run:
23+
shell: bash
24+
steps:
25+
- uses: actions/checkout@v2
26+
with:
27+
submodules: true
28+
- uses: actions/setup-python@v2
29+
with:
30+
python-version: '3.x'
31+
- name: Build
32+
run: |
33+
sudo apt update
34+
sudo apt install python3-pip python3-setuptools
35+
# GitHub CI installs pip3 and setuptools outside the path.
36+
# Update the path to include them and run.
37+
PATH=/home/runner/.local/bin:$PATH pip3 install --user -r ./docs/requirements.txt
38+
cd ./docs && PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" make html

Diff for: docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
# a list of builtin themes.
5757
#
5858
html_theme = 'default'
59-
html_logo = 'logo_espressif.png'
59+
html_logo = '_static/logo_espressif.png'
6060

6161
# Add any paths that contain custom static files (such as style sheets) here,
6262
# relative to this directory. They are copied after the builtin static files,

0 commit comments

Comments
 (0)