Skip to content

Commit ad09fb0

Browse files
committed
Add python docs
1 parent cd8d3a9 commit ad09fb0

File tree

4 files changed

+20
-8
lines changed

4 files changed

+20
-8
lines changed

.github/workflows/sphinx-docs.yml

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ name: Documentation Build & Deploy
22

33
on:
44
push:
5-
branches: [main]
5+
branches: [docs_publish]
66
pull_request:
7-
branches: [main]
7+
branches: [docs_publish]
88
workflow_dispatch:
99

1010
jobs:
@@ -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

.github/workflows/test_windows.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Windows Build
22

33
# Controls when the action will run.
4-
on: [push]
4+
#on: [push]
55

66
jobs:
77
build:

client/python/projectairsim/docs/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@
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'
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
sphinx
2+
sphinx_rtd_theme
3+
myst_parser

0 commit comments

Comments
 (0)