Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 5fa5993

Browse files
committedAug 5, 2022
[Docs] New docs theme based on ESP-IDF style (#6512)
1 parent 60c4eea commit 5fa5993

File tree

90 files changed

+148
-179
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+148
-179
lines changed
 

‎.github/workflows/docs.yml

+20-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: ReadTheDocs CI
1+
name: Docs CI
22

33
on:
44
push:
@@ -15,8 +15,8 @@ on:
1515

1616
jobs:
1717

18-
build-docs:
19-
name: Build ReadTheDocs
18+
deploy-preview-docs:
19+
name: Deploy Preview Docs
2020
runs-on: ubuntu-latest
2121
defaults:
2222
run:
@@ -28,11 +28,23 @@ jobs:
2828
- uses: actions/setup-python@v2
2929
with:
3030
python-version: '3.x'
31-
- name: Build
31+
- name: Deploy Preview
32+
env:
33+
DOCS_BUILD_DIR: "./docs/_build/"
34+
DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_DEPLOY_KEY }}
35+
DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PREV_SERVER }}
36+
DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PREV_SERVER_USER }}
37+
DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PREV_PATH }}
38+
DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PREV_URL }}
3239
run: |
3340
sudo apt update
3441
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
42+
source ./docs/utils.sh
43+
add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
44+
export GIT_VER=$(git describe --always)
45+
echo "PIP install requirements..."
46+
pip3 install --user -r ./docs/requirements.txt
47+
echo "Building the Docs..."
48+
cd ./docs && build-docs -l en
49+
echo "Deploy the Docs..."
50+
deploy-docs

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ boards.sloeber.txt
2323
# Ignore docs build (Sphinx)
2424
docs/build
2525
docs/source/_build
26+
docs/__pycache__/
27+
docs/_build/
2628

2729
# Test log files
2830
*.log

0 commit comments

Comments
 (0)