Skip to content

Add initial documentation structure and contributing guide (#3) #7

Add initial documentation structure and contributing guide (#3)

Add initial documentation structure and contributing guide (#3) #7

Workflow file for this run

name: "Sphinx: Render docs"
on: push
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- name: Set up uv
uses: astral-sh/setup-uv@v5
with:
python-version: "3.13"
- name: Install dependencies
run: uv sync
- name: Build HTML
run: cd docs && uv run make html
- 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