Skip to content

Keep docs in sync with master branch #249

Keep docs in sync with master branch

Keep docs in sync with master branch #249

Workflow file for this run

name: Build & Deploy docs
on:
push:
tags:
- '*' # This will trigger on any tag push, regardless of changes
branches:
- master # This branch filter applies only to the paths below
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: false
permissions:
contents: read
pages: write
id-token: write
jobs:
build-docs:
runs-on: ubuntu-latest
name: Build & Deploy docs
steps:
- uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v3
- name: Set up Python
run: uv python install 3.11
- name: Enable caching
uses: astral-sh/setup-uv@v3
with:
enable-cache: true
cache-dependency-glob: |
**/pyproject.toml
- name: Install the project
run: uv sync --extra docs --extra all
- name: Documentation dependencies
working-directory: python
run: |
sudo apt-get update
sudo apt-get install -y pandoc
sudo apt install -y graphviz
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Build Python documentation
working-directory: python/docs
run: make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: python/docs/build/html
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build-docs
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4