Skip to content

Commit db9e314

Browse files
committed
Add documentation build job
1 parent 4977294 commit db9e314

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed

.github/workflows/docs.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy documentation
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
build-docs:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
max-parallel: 5
14+
15+
steps:
16+
- name: Checkout playzerx repo
17+
uses: actions/checkout@v4
18+
- name: Set up Python 3.10
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: '3.10'
22+
- name: Install dependencies & build
23+
run: |
24+
cd docs
25+
pip install --upgrade pip
26+
mkdir venv
27+
python3 -m venv ./venv
28+
ls venv/
29+
source ./venv/bin/activate
30+
pip install -r requirements.txt
31+
sudo apt-get install doxygen graphviz -y
32+
33+
# Build Doxygen source
34+
doxygen Doxyfile
35+
36+
# Build webpage from Sphinx
37+
make html
38+
- name: Upload build artifact
39+
uses: actions/upload-artifact@v4
40+
with:
41+
name: docs-artifact
42+
path: docs/build/

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -216,3 +216,6 @@ gcc_*
216216

217217
#Matlab backups
218218
*.asv
219+
220+
# Documentation virtual environment
221+
docs/venv/

docs/requirements.txt

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
breathe==4.34.0
2+
sphinx==5.3.0
3+
jinja2==3.1.4
4+
markupsafe==2.1.1
5+
sphinx-copybutton==0.5.1
6+
sphinx-book-theme
7+
sphinx-copybutton==0.5.1 # For copy buttons in code blocks
8+
sphinx-inline-tabs==2022.1.2b11 # For inline tabs (e.g. for different OSes, programming languages, etc.)
9+
sphinxext-opengraph==0.8.0 # For social media sharing

0 commit comments

Comments
 (0)