documentation.yml

name: Docs
# on: [push, pull_request, workflow_dispatch]
on:
    # Runs on pushes targeting the default branch
    push:
      branches: ["main"]
    # Allows you to run this workflow manually from the Actions tab
    workflow_dispatch:
permissions:
    contents: read
    pages: write
    id-token: write
concurrency:
    group: "pages"
    cancel-in-progress: false
env:
    PYTHON_VERSION: 3.11
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: ${{ env.PYTHON_VERSION }}
      - name: Install dependencies
        run: |
            python -m pip install --upgrade pip
            pip install sphinx pydata-sphinx-theme sphinx-autobuild sphinx-gallery sphinxcontrib-bibtex myst-nb nbsphinx numpydoc matplotlib seaborn sphinx-sitemap sphinx-favicon jupytext
            if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
            pip install -e .
      - name: Sphinx build
        run: |
            cd doc
            make html
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
            path: doc/_build/html
  deploy:
    needs: build
    environment:
        name: github-pages
        url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
        - name: Checkout
          uses: actions/checkout@v4
        - name: Setup Pages
          uses: actions/configure-pages@v4
        - name: Deploy to GitHub Pages
          id: deployment
          uses: actions/deploy-pages@v4