Skip to content

fix: configure() no longer overwrites config set by configure_*() sub-methods #5651

fix: configure() no longer overwrites config set by configure_*() sub-methods

fix: configure() no longer overwrites config set by configure_*() sub-methods #5651

Workflow file for this run

name: Docs
on:
push:
branches:
- main
paths: &docbuild_paths
- ".github/workflows/docbuild.yml"
- "doc/**"
- "_data/**"
- "pyproject.toml"
- "sphinxext/**"
- "tests/examples_*/**"
- "tools/**"
- "uv.lock"
pull_request:
paths: *docbuild_paths
jobs:
build-docs:
name: Build docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
fetch-depth: 0
- name: Set up Python 3.12
uses: actions/setup-python@v6
with:
python-version: "3.12"
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
enable-cache: true
cache-dependency-glob: |
**/uv.lock
**/pyproject.toml
- name: Install dependencies
run: uv sync --all-extras
- name: Build docs
run: |
mkdir -p doc/_images
uv run sphinx-build -b html -d doc/_build/doctrees doc doc/_build/html
- name: Check examples index is up to date
run: |
if ! git diff --exit-code -- _data/examples.json; then
echo "::error file=_data/examples.json::The examples index is stale. Run 'uv run task doc-build --no-autosummary' and commit the updated _data/examples.json."
exit 1
fi
- name: Upload docs preview artifact
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: docs-html
path: doc/_build/html
retention-days: 7
- name: Run doctests
run: |
uv run sphinx-build -b doctest -d doc/_build/doctrees doc doc/_build/doctest