Skip to content

docs

docs #1

Workflow file for this run

name: docs
on:
release:
types: [published]
workflow_dispatch:
permissions:
contents: read
jobs:
docs:
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install .[docs] --upgrade pip
pip install sphinx
- name: Generate API docs & Build sphinx documentation
run: |
sphinx-build -M help docs docs-out
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs-out'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4