Skip to content
documentation

docs: add section for building docs #67

Sign in to view logs

docs: add section for building docs

docs: add section for building docs #67

Workflow file for this run

.github/workflows/documentation.yml at 978c4bf
name: documentation
on:
push:
pull_request:
workflow_dispatch:
inputs:
deploy:
description: 'Deploy documentation'
required: false
type: boolean
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- name: Install dependencies
run: |
pip install uv
- name: Sphinx build
run: |
uv run --group docs --no-cache --with-editable . sphinx-build docs/source _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: github.event_name == 'workflow_dispatch' && github.event.inputs.deploy == 'true'
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true