Skip to content
Build Documentation

Feature/add analytic test rpcholesky #1090

Sign in to view logs

Feature/add analytic test rpcholesky

Feature/add analytic test rpcholesky #1090

Workflow file for this run

.github/workflows/docs.yml at 3bf7cce
name: Build Documentation
on:
push:
branches:
- main
pull_request:
branches:
- "**"
jobs:
build:
name: Build documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up base Python
uses: actions/setup-python@v5
with:
# Note that this is just the version of Python that we use to run `uv` with.
# `uv` manages its own version of Python.
# For speed, we use the same version for both, but in principle these could differ.
python-version: 3.12
- name: Set up uv cache directory location (Linux/Mac)
run: echo "UV_CACHE_DIR=${{ runner.temp }}/.uv-cache" >> $GITHUB_ENV
if: runner.os != 'Windows'
- name: Set up uv cache directory location (Windows)
run: echo "UV_CACHE_DIR=${{ runner.temp }}/.uv-cache" >> $env:GITHUB_ENV
if: runner.os == 'Windows'
- name: Restore uv cache
uses: actions/cache@v4
with:
path: ${{ env.UV_CACHE_DIR }}
key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}-${{ matrix.python-version }}-test
restore-keys: |
uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}-${{ matrix.python-version }}
uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
uv-${{ runner.os }}
- name: Install latest versions of pip and uv
run: python -m pip install --upgrade pip uv
- name: Install documentation dependencies
run: uv sync --extra doc --no-dev --locked
- name: Debug - uv pip freeze
run: uv pip freeze
- name: Build documentation
run: |
uv run -m sphinx -b html -aE -n -W --keep-going documentation/source documentation/build
- name: Check external links
run: |
uv run -m sphinx -b linkcheck documentation/source documentation/build
- name: Minimize UV cache
run: uv cache prune --ci
if: always()