Skip to content

Commit a5653a3

Browse files
committed
Try new pipeline
1 parent 7a639ac commit a5653a3

File tree

4 files changed

+108
-13
lines changed

4 files changed

+108
-13
lines changed

.github/workflows/sphinx-docs.yml

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build and Deploy Sphinx Docs
1+
name: Build and Deploy Docs
22

33
on:
44
push:
@@ -7,7 +7,7 @@ on:
77
branches: [docs_publish]
88

99
jobs:
10-
build-docs:
10+
deploy-docs:
1111
runs-on: ubuntu-latest
1212

1313
steps:
@@ -17,22 +17,26 @@ jobs:
1717
- name: Set up Python
1818
uses: actions/setup-python@v5
1919
with:
20-
python-version: '3.10'
20+
python-version: 3.10
2121

2222
- name: Install dependencies
2323
run: |
24-
python -m pip install --upgrade pip
24+
pip install --upgrade pip
2525
pip install -r docs/requirements.txt
2626
27-
- name: Build HTML with Sphinx
28-
working-directory: ./docs
27+
- name: Build documentation
28+
working-directory: docs
2929
run: make html
3030

3131
- name: Deploy to gen_page branch
32-
if: github.event_name == 'push'
33-
uses: peaceiris/actions-gh-pages@v3
34-
with:
35-
github_token: ${{ secrets.GITHUB_TOKEN }}
36-
publish_dir: ./docs/build/html
37-
publish_branch: gen_page
38-
force_orphan: true
32+
run: |
33+
git config user.name "github-actions[bot]"
34+
git config user.email "github-actions[bot]@users.noreply.github.com"
35+
git fetch origin
36+
git switch --orphan gen_page
37+
git rm -rf .
38+
cp -r docs/build/html/* .
39+
touch .nojekyll
40+
git add .
41+
git commit -m "Deploy documentation to gen_page"
42+
git push -f origin gen_page

docs/Makefile

100644100755
File mode changed.

docs/source/conf.py

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
# Configuration file for the Sphinx documentation builder.
3+
#
4+
# For the full list of built-in configuration values, see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
import sphinx_rtd_theme
8+
9+
# -- Project information -----------------------------------------------------
10+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
11+
12+
project = 'Project Airsim'
13+
copyright = '2025, IAMAI'
14+
author = 'IAMAI'
15+
release = '0.1'
16+
17+
# -- General configuration ---------------------------------------------------
18+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
19+
20+
extensions = ["myst_parser"]
21+
22+
templates_path = ['_templates']
23+
exclude_patterns = []
24+
25+
source_suffix = {
26+
'.rst': 'restructuredtext',
27+
'.md': 'markdown',
28+
}
29+
30+
# -- Options for HTML output -------------------------------------------------
31+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
32+
33+
html_theme = 'sphinx_rtd_theme'
34+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

docs/source/index.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Project AirSim Documentation
2+
3+
Welcome to the Project AirSim documentation!
4+
5+
```{include} ../../README.md
6+
:relative-docs: docs_build/source
7+
:relative-images: docs_build/source/images
8+
```
9+
10+
```{toctree}
11+
:maxdepth: 2
12+
:caption: Getting Started
13+
internal/use_source.md
14+
internal/use_prebuilt.md
15+
internal/dev_setup_linux.md
16+
internal/dev_setup_win.md
17+
internal/headless_cloud.md
18+
internal/vscode_user_settings.md
19+
---
20+
:maxdepth: 2
21+
:caption: ROS Integration
22+
ros/ros.md
23+
ros/ros2.md
24+
ros/ros_examples.md
25+
ros/example_build_map.md
26+
ros/example_navigate_map.md
27+
---
28+
:maxdepth: 2
29+
:caption: Sensors
30+
sensors/battery.md
31+
sensors/lidar.md
32+
sensors/radar.md
33+
sensors/segmentation.md
34+
sensors/camera_capture_settings.md
35+
sensors/camera_post_processing_with_nn.md
36+
sensors/camera_streaming.md
37+
---
38+
:maxdepth: 2
39+
:caption: Data Collection
40+
datacollection/config.md
41+
datacollection/data_aggregation.md
42+
datacollection/data_generation.md
43+
datacollection/randomizations.md
44+
datacollection/trajectory.md
45+
---
46+
:maxdepth: 2
47+
:caption: Physics
48+
physics/fast_physics.md
49+
physics/matlab_physics.md
50+
internal/physics/unreal_physics.md
51+
---
52+
:maxdepth: 2
53+
:caption: Scene and Simulation
54+
scene/sim_clock.md
55+
scene/weather_visual_effects.md
56+
internal/scene/sim_clock_internal.md
57+
internal/sensors/display.md

0 commit comments

Comments
 (0)