sphinx.yml

name: Sphinx build

on:
  push:
  pull_request:
    branches:
      - main

jobs:
  build-sphinx-doc:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
      with:
        fetch-depth: 0

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

    - name: Set up Poetry
      uses: abatilo/actions-poetry@v3

    - name: Build HTML documentation
      run: |
        poetry self add "poetry-dynamic-versioning[plugin]"
        poetry install --with docs
        poetry run sphinx-build docs ./docs/_build/html/

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

    - name: Deploy
      uses: peaceiris/actions-gh-pages@v4
      if: github.ref == 'refs/heads/main'
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: docs/_build/html