Skip to content

feat(docs): migrate documentation to MkDocs with auto-generated API reference #2

feat(docs): migrate documentation to MkDocs with auto-generated API reference

feat(docs): migrate documentation to MkDocs with auto-generated API reference #2

Workflow file for this run

name: docs
on:
push:
branches:
- main
paths:
- 'docs/**'
- 'src/**'
- 'mkdocs.yml'
- 'scripts/gen_api_ref.py'
- '.github/workflows/docs.yaml'
pull_request:
branches:
- main
paths:
- 'docs/**'
- 'src/**'
- 'mkdocs.yml'
- 'scripts/gen_api_ref.py'
- '.github/workflows/docs.yaml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install uv
uses: astral-sh/setup-uv@v4
- name: Install dependencies
run: uv sync --group docs
- name: Build documentation
run: uv run mkdocs build
- name: Upload artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: site/
deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4