docs.yml

name: Deploy docs to Pages

on:
  push:
    branches:
    - master

  workflow_dispatch:


permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    name: build docs
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4

    - uses: actions/setup-python@v5
      with:
        python-version: "3.11"

    - name: Install deps
      run: python -m pip install -r docs/requirements.txt

    - name: Install self
      run: python -m pip install .

    - name: Build docs
      run: sphinx-build docs _site -b dirhtml

    - name: Upload artifact
      uses: actions/upload-artifact@v3

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest
    needs: build

    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4