Skip to content

Fix broken link

Fix broken link #387

Workflow file for this run

name: Documentation
on:
workflow_dispatch:
pull_request:
push:
branches:
- main
release:
types:
- published
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
env:
# Many color libraries just need this to be set to any value, but at least
# one distinguishes color depth, where "3" -> "256-bit color".
FORCE_COLOR: 3
jobs:
docs-build:
name: Documentation build
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: astral-sh/setup-uv@v7
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install
shell: bash -l {0}
run: source continuous_integration/scripts/install.sh
- name: Install docs requirements
shell: bash -l {0}
run: |
set -vxeuo pipefail
python -m pip install -r requirements-docs.txt
python -m pip list
- name: Build HTML
run: sphinx-build docs/source docs/_build/html
- name: Upload HTML as GitHub artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html
docs-publish:
name: Deploy documentation to GitHub Pages
runs-on: ubuntu-latest
needs: docs-build
if: ${{ github.ref_name == 'main' }}
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Setup GitHub Pages
uses: actions/configure-pages@v5
- name: Deploy HTML to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4