-
Notifications
You must be signed in to change notification settings - Fork 1
44 lines (40 loc) · 1.09 KB
/
sphinx.yml
File metadata and controls
44 lines (40 loc) · 1.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
name: "Sphinx: Render docs"
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Install Doxygen
run: sudo apt-get install -y doxygen
- name: Generate Doxygen documentation
run: doxygen docs/Doxyfile.in
# Install Python dependencies
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install breathe sphinx sphinx-copybutton pydata-sphinx-theme
- name: Build HTML
run: |
sphinx-build -b html docs/source docs/build/html
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html/