docs.yml

# Simple workflow for deploying static content to GitHub Pages
name: Docs

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["master", "docs"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

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

jobs:
  # Single deploy job since we're just deploying
  deploy:
    strategy:
      matrix:
        python-version: ["3.10.8"]

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    env:
      DOCS_DIR: docs
      DOCS_BUILD_DIR: docs/build
      DOCS_BUILD_HTML_DIR: docs/build/html

    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          pip install -r ${{ env.DOCS_DIR }}/requirements.txt
      - name: Build User Manual in HTML
        run: |
          cd ${{ env.DOCS_DIR }}
          make html
      - name: Setup Pages
        uses: actions/configure-pages@v2
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ${{ env.DOCS_BUILD_HTML_DIR }}
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1