Skip to content

[contrib][doc] Setup documentation demo #1

[contrib][doc] Setup documentation demo

[contrib][doc] Setup documentation demo #1

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages
on:
# Runs on pushes targeting the default branch
push:
# TODO: Change this to dev
branches: ["2025-01-20-mkdocs"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup build environment
run: |
sudo apt-get update
sudo apt-get install doxygen clang-format
pip install mkdocs-material==9.5.50 mkdocstrings==0.27.0 mkdocs-autorefs=0.13.0
- name: build
run: |
./contrib/doc/mkdocs.py build
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload the built site
path: './build-doc/site/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4