Skip to content
Build sphinx documentation

Adding docstrings and introducing sphinx draft (#12) #2

Sign in to view logs

Adding docstrings and introducing sphinx draft (#12)

Adding docstrings and introducing sphinx draft (#12) #2

Workflow file for this run

.github/workflows/docs.yml at d0ee406
name: Build sphinx documentation
on:
push:
paths:
- 'docs/**'
branches:
- main
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- name: Install uv
uses: astral-sh/setup-uv@v3
- name: Install project
run: |
make install-dev
- name: Generate docs
run:
source .venv/bin/activate
make sphinx-docs
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/_build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html