Skip to content

fix: resolve prek issues and min errors on reeds translation #668

fix: resolve prek issues and min errors on reeds translation

fix: resolve prek issues and min errors on reeds translation #668

Workflow file for this run

name: Documentation
on:
push:
branches: [main]
paths:
- "docs/**"
- "src/**"
- "packages/*/src/**"
- "pyproject.toml"
pull_request:
paths:
- "docs/**"
- "src/**"
- "packages/*/src/**"
- "pyproject.toml"
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: read
env:
UV_VERSION: "0.11.6"
jobs:
build:
name: Build documentation
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6
with:
persist-credentials: false
- name: Setup uv environment
uses: ./.github/actions/setup-uv-env
with:
uv-version: ${{ env.UV_VERSION }}
python-version-file: "pyproject.toml"
sync-args: "--group docs"
- name: Build Sphinx documentation
run: uv run sphinx-build docs/source/ docs/build/
- name: Upload built docs artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: docs-site
path: docs/build/
deploy:
name: Deploy to GitHub Pages
needs: build
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
timeout-minutes: 10
permissions:
contents: write # Required: push generated docs to gh-pages
steps:
- name: Download built docs artifact
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
with:
name: docs-site
path: docs/build/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/
force_orphan: true