Skip to content

Commit 858bccb

Browse files
committed
Add ci job for building the docs
1 parent 94673c5 commit 858bccb

File tree

3 files changed

+35
-2
lines changed

3 files changed

+35
-2
lines changed

.github/workflows/sphinx_build.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: "Build documentation"
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
push:
7+
branches:
8+
- main
9+
schedule:
10+
- cron: '38 2 * * *'
11+
12+
jobs:
13+
docs:
14+
runs-on: ubuntu-latest
15+
permissions:
16+
contents: write
17+
concurrency:
18+
group: ${{ github.workflow }}-${{ github.ref }}
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-python@v5
22+
with:
23+
cache: 'pip'
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install -r doc_requirements.txt
28+
- name: Build documentation
29+
run: |
30+
sphinx-build -b html . _doc_build

conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,13 @@
4747
# ones.
4848
extensions = [
4949
"sphinx_copybutton",
50-
"sphinx_favicon",
5150
"sphinx_rtd_theme",
5251
]
5352

5453
copybutton_exclude = ".linenos, .gp, .go"
5554

5655
# Add any paths that contain templates here, relative to this directory.
57-
templates_path = ["_templates"]
56+
templates_path = ["doc/_templates"]
5857

5958
# The suffix(es) of source filenames.
6059
# You can specify multiple suffix as a list of string:

doc_requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
sphinx
2+
sphinx_rtd_theme
3+
sphinx-copybutton
4+
catkin-pkg

0 commit comments

Comments
 (0)