feat(docs): add mkdocs and ci (#114)

This commit is contained in:
banteg
2026-01-13 06:00:26 +04:00
committed by GitHub
parent d4aad8e068
commit d0e9a51a0f
8 changed files with 655 additions and 3 deletions
+4
View File
@@ -38,6 +38,10 @@ jobs:
do_sync: false
command: uv build
sync_args: ""
- task: docs
do_sync: true
command: uv run --no-sync mkdocs build --strict
sync_args: --no-install-project --group docs
steps:
- name: Checkout
+57
View File
@@ -0,0 +1,57 @@
name: Docs
on:
push:
branches: ["master"]
paths:
- "docs/**"
- "src/**"
- "mkdocs.yml"
- "pyproject.toml"
- "uv.lock"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
python-version: "3.14"
enable-cache: true
- name: Sync docs dependencies
run: uv sync --frozen --no-install-project --group docs
- name: Build site
run: uv run --no-sync mkdocs build --strict
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: _site
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