sphinx.yaml

name: "Sphinx: Render docs"

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest

    permissions:
      contents: write

    steps:
    - uses: actions/checkout@v4

    - name: Setup Python Environment
      uses: actions/setup-python@v3
      with:
        python-version: '3.12'

    - name: Install docs dependencies
      run: |
        python3 -m pip install -U pip
        pip install -e .
        pip install -r requirements/requirements-docs.txt

    - name: Build HTML
      uses: ammaraskar/sphinx-action@master

    - name: Upload artifacts
      uses: actions/upload-artifact@v4
      with:
        name: html-docs
        path: docs/_build/html/

    - name: Deploy
      uses: peaceiris/actions-gh-pages@v3
      with:
        docs-folder: "docs/"

        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: docs/_build/html