Skip to content
This repository was archived by the owner on Mar 27, 2026. It is now read-only.

docs

docs #253

Workflow file for this run

name: docs
on:
pull_request:
push:
branches:
- main
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
build-docs:
name: build-docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: pip
cache-dependency-path: web/docs/requirements-docs.txt
- name: Install docs dependencies
run: pip install -r web/docs/requirements-docs.txt
- name: Build docs
run: mkdocs build --strict -f web/docs/mkdocs.yml
- name: Upload Pages artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: site
deploy-docs:
name: deploy-docs
runs-on: ubuntu-latest
needs: build-docs
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4