feat: Make Python version configurable #2564
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build documentation | |
| on: | |
| # run on PRs for validation | |
| pull_request: | |
| jobs: | |
| test-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Set up Git repository | |
| uses: actions/checkout@v6 | |
| - name: Install system requirements | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y pandoc | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| enable-cache: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version-file: "pyproject.toml" | |
| - name: Restore UV environment | |
| run: cp production.uv.lock uv.lock | |
| - name: Install doc requirements | |
| run: | | |
| uv sync --extra docs --frozen | |
| # TEMPORARY: sphinx-click cannot introspect typer's vendored click (typer | |
| # >= 0.26), which breaks the CLI reference pages. Pin to the last real-click | |
| # typer for the docs build only (does not affect the shipped package) until | |
| # we settle on a long-term docs fix. See the docs CLI reference pages. | |
| - name: Pin typer < 0.26 for docs build (sphinx-click compatibility) | |
| run: uv pip install 'typer<0.26' | |
| - name: Build docs | |
| working-directory: docs | |
| run: | | |
| export SPHINXOPTS="-W" # treat warnings as errors | |
| uv run --no-sync make html |