Skip to content

Tests with Doxygen

Tests with Doxygen #3

Workflow file for this run

name: Docs
on:
push:
paths:
- "**/workflows/docs.yml"
- "**/docs/**"
branches: [main]
pull_request:
paths:
- "**/workflows/docs.yml"
- "**/docs/**"
branches: [main]
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Install Doxygen
run: sudo apt-get update && sudo apt-get install -y doxygen
- name: Run Doxygen
run: doxygen Doxyfile
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install Python deps
run: pip install -r docs/requirements.txt
- name: Build Sphinx
run: |
python -m sphinx -T -j auto -b html \
-d docs/_build/doctrees \
-D language=en \
docs \
docs/_build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html
deploy:
if: github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-24.04
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4