Skip to content

fix(gateway): correct fault filtering for entities and complete type_… #380

fix(gateway): correct fault filtering for entities and complete type_…

fix(gateway): correct fault filtering for entities and complete type_… #380

Workflow file for this run

name: Documentation
on:
push:
branches: [main]
paths:
- "docs/**"
- "src/**"
- "scripts/**"
- ".github/workflows/docs.yml"
pull_request:
branches: [main]
paths:
- "docs/**"
- "src/**"
- "scripts/**"
- ".github/workflows/docs.yml"
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build-docs:
runs-on: ubuntu-24.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: recursive
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: "pip"
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y graphviz plantuml doxygen
pip install -e docs/.[dev]
- name: Generate Doxygen XML
working-directory: docs
run: |
mkdir -p _build/doxygen/xml
doxygen Doxyfile
- name: Generate verification report
run: python3 scripts/generate_verification.py
- name: Check links
working-directory: docs
run: sphinx-build -b linkcheck . _build/linkcheck
- name: Build documentation
working-directory: docs
run: sphinx-build -b html . _build/html -W --keep-going
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html
deploy-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-24.04
needs: build-docs
if: github.ref == 'refs/heads/main'
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4