Add Sphinx documentation with Diataxis structure and GitHub Pages dep… #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| name: Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - "docs/**" | |
| - ".github/workflows/docs.yaml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| 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" | |
| - uses: astral-sh/setup-uv@v4 | |
| - name: Install docs dependencies | |
| working-directory: docs | |
| run: | | |
| uv venv .venv | |
| uv pip install sphinx sphinx-autobuild \ | |
| myst_parser sphinxcontrib.mermaid shibuya \ | |
| sphinx-design sphinx-copybutton | |
| - name: Build documentation | |
| working-directory: docs | |
| run: .venv/bin/sphinx-build sources html | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/html | |
| deploy: | |
| 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 |