Skip to content

Add Sphinx documentation with Diataxis structure and GH Pages deploy #1

Add Sphinx documentation with Diataxis structure and GH Pages deploy

Add Sphinx documentation with Diataxis structure and GH Pages deploy #1

Workflow file for this run

name: docs
on:
push:
branches: [main]
paths:
- 'docs/**'
workflow_dispatch:
# Allow only one concurrent deployment
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install uv
run: pip install uv
- name: Build docs
working-directory: docs
run: make docs
- uses: actions/upload-pages-artifact@v3
with:
path: docs/html
deploy:
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4