File tree Expand file tree Collapse file tree 4 files changed +20
-8
lines changed
client/python/projectairsim/docs Expand file tree Collapse file tree 4 files changed +20
-8
lines changed Original file line number Diff line number Diff line change @@ -2,9 +2,9 @@ name: Documentation Build & Deploy
22
33on :
44 push :
5- branches : [main ]
5+ branches : [docs_publish ]
66 pull_request :
7- branches : [main ]
7+ branches : [docs_publish ]
88 workflow_dispatch :
99
1010jobs :
@@ -23,18 +23,29 @@ jobs:
2323 with :
2424 python-version : ' 3.12'
2525
26- - name : Install dependencies
26+ - name : Install dependencies for main docs
2727 run : |
2828 python -m pip install --upgrade pip
2929 pip install -r docs/requirements.txt
3030
31- - name : Build Sphinx documentation
31+ - name : Build Sphinx documentation (main)
3232 working-directory : docs
3333 run : make html
3434
35+ - name : Install dependencies for Python API docs
36+ run : pip install -r client/python/projectairsim/docs/requirements.txt
37+
38+ - name : Build Python API docs
39+ working-directory : client/python/projectairsim/docs
40+ run : make html
41+
42+ - name : Copy API docs into main site
43+ run : |
44+ mkdir -p docs/build/html/api_docs
45+ cp -r client/python/projectairsim/docs/build/html/* docs/build/html/api_docs/
46+
3547 - name : Deploy to GitHub Pages (gh_page)
3648 uses : peaceiris/actions-gh-pages@v3
37- if : ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
3849 with :
3950 github_token : ${{ secrets.GITHUB_TOKEN }}
4051 publish_dir : docs/build/html
Original file line number Diff line number Diff line change 11name : Windows Build
22
33# Controls when the action will run.
4- on : [push]
4+ # on: [push]
55
66jobs :
77 build :
Original file line number Diff line number Diff line change 1919# -- Options for HTML output -------------------------------------------------
2020# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
2121
22- html_theme = 'haiku'
23- html_static_path = ['_static' ]
22+ html_theme = 'sphinx_rtd_theme'
Original file line number Diff line number Diff line change 11sphinx
2+ sphinx_rtd_theme
3+ myst_parser
You can’t perform that action at this time.
0 commit comments