Skip to content

Release/0.3.0

Release/0.3.0 #1100

Workflow file for this run

name: Build Documentation
on:
push:
branches:
- main
pull_request:
branches:
- "**"
jobs:
build:
name: Build documentation with latest dependencies
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: pip
cache-dependency-path: pyproject.toml
- name: Upgrade pip
run: python -m pip install --upgrade pip
- name: Install test dependencies
run: pip install -e .[doc]
- name: Build documentation
run: |
python -m sphinx -b html -aE -n -W --keep-going documentation/source documentation/build
- name: Check external links
run: |
python -m sphinx -b linkcheck documentation/source documentation/build
build-pinned:
name: Build documentation with pinned package versions
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: pip
cache-dependency-path: requirements-doc.txt
- name: Upgrade pip
run: python -m pip install --upgrade pip
- name: Install test dependencies
run: pip install --no-dependencies -r requirements-doc.txt
- name: Build documentation
run: |
python -m sphinx -b html -aE -n -W --keep-going documentation/source documentation/build
- name: Check external links
run: |
python -m sphinx -b linkcheck documentation/source documentation/build