Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Documentation

on:
push:
branches: [main]
paths:
- "docs/**"
- ".github/workflows/docs.yml"
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 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
10 changes: 10 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ recursive-include src *.sh
recursive-include src *.txt
recursive-include src *.yml

recursive-include docs *.gitignore
recursive-include docs *.ini
recursive-include docs *.md
recursive-include docs *.py
recursive-include docs *.txt
recursive-include docs Makefile

recursive-exclude docs/.venv *
recursive-exclude docs/.mxmake *
recursive-exclude docs/html *
recursive-exclude news *
recursive-exclude config *
recursive-exclude shared-workflows *
Loading