Skip to content

docs: refactor to mkdocs #20

docs: refactor to mkdocs

docs: refactor to mkdocs #20

name: Build and Deploy Documentation
on:
push:
branches:
- main
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
docs:
runs-on: ubuntu-24.04
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Set up Rust
uses: actions-rust-lang/setup-rust-toolchain@v1
with:
toolchain: stable
- name: Set up uv
uses: astral-sh/setup-uv@v5
with:
pyproject-file: "pyproject.toml"
enable-cache: true
cache-dependency-glob: "**/pyproject.toml"
- name: Install the project
run: uv sync --group docs
- name: Build documentation
run: uv run mkdocs build -d site
- name: Upload documentation artifact
uses: actions/upload-pages-artifact@v3
with:
path: "site"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4