sphinx.yaml

name: "Sphinx: Render docs"

on: push

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

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
    - uses: actions/checkout@v4

    # Setting up the environment
    - name: Setup Pages
      uses: actions/configure-pages@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.11'

    - name: Install Poetry
      run: pip install poetry

    - name: Install dependencies with Poetry
      run: poetry install -C docs

    # Building
    - name: Build HTML using Poetry
      run: poetry run -C docs sphinx-build -M html docs/source/ docs/build/

    # Upload
    - name: Upload artifacts
      uses: actions/upload-pages-artifact@v3
      with:
        name: github-pages
        path: docs/build/html/

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

    needs: build

    # Specify runner + deployment step
    runs-on: ubuntu-latest

    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4
      with:
        artifact_name: github-pages
        preview: false # Not yet available to the public.