Skip to content

bpm cleaning and some more settings #1332

bpm cleaning and some more settings

bpm cleaning and some more settings #1332

Workflow file for this run

# Build documentation and upload to gh-pages
name: Ensure documentation builds after commits
defaults:
run:
shell: bash
on: [push, pull_request] # Runs on all push events to any branch
# We use uv pip and it should use the system python from our runner
env:
UV_SYSTEM_PYTHON: 1
jobs:
documentation:
name: Build Static Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
enable-cache: true
cache-dependency-glob: "requirements.txt"
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.13
- name: Install dependencies
run: uv pip install -r requirements.txt
- name: Build documentation
run: uv run python -m mkdocs build -d ./doc_build
# Upload artifacts if in PR so reviewers can have a quick look without building documentation from the branch locally
- name: Upload build artifacts
uses: actions/upload-artifact@v4
if: success() && github.event_name == 'pull_request'
with:
name: site-build
path: doc_build
retention-days: 5