Skip to content

Streamlined the documentation in preparation for next release #51

Streamlined the documentation in preparation for next release

Streamlined the documentation in preparation for next release #51

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v6
with:
python-version: '3.12'
cache: 'pip'
- name: Install dependencies
run: |
pip install --upgrade pip
pip install -e ".[docs]"
- name: Cache Sphinx build
uses: actions/cache@v4
with:
path: docs/_build
key: sphinx-${{ runner.os }}-${{ hashFiles('docs/source/**/*', 'pyproject.toml') }}
restore-keys: |
sphinx-${{ runner.os }}-
- name: Build documentation with Sphinx
run: |
cd docs
sphinx-build -b html source _build/html
- name: Upload Pages artifact
if: github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html
deploy:
if: github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4