Skip to content

doc: update certificate generation information #9

doc: update certificate generation information

doc: update certificate generation information #9

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- master
paths:
- 'documentation/**'
- '.github/workflows/docs.yml'
pull_request:
paths:
- 'documentation/**'
- '.github/workflows/docs.yml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: '3.12'
- name: Install dependencies
run: |
sudo apt-get update && sudo apt-get install -y doxygen
python -m pip install --upgrade pip
pip install "sphinx<8" "docutils<0.21" sphinx-rtd-theme myst-parser breathe
- name: Run Doxygen
run: doxygen documentation/Doxyfile
- name: Build HTML
run: sphinx-build -b html documentation documentation/build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v5
with:
path: 'documentation/build/html'
deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5