Skip to content

πŸ“ docs: correct some mistakes in the docs #5

πŸ“ docs: correct some mistakes in the docs

πŸ“ docs: correct some mistakes in the docs #5

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
paths:
- "docs/**"
- "mkdocs.yml"
pull_request:
paths:
- "docs/**"
- "mkdocs.yml"
workflow_dispatch:
permissions:
contents: write
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
fetch-depth: 0
- uses: astral-sh/setup-uv@e06108dd0aef18192324c70427afc47652e63a82 # v7
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
with:
python-version: "3.12"
- name: Install dependencies
run: uv pip install --system -r docs/requirements.txt
- name: Build documentation
if: github.event_name == 'pull_request'
run: mkdocs build --strict
env:
CI: "true"
- name: Deploy documentation
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
run: mkdocs gh-deploy --force
env:
CI: "true"
DEPLOY: "true"