docs.yml

name: Documentation

on:
  push:
    branches: [main]

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

permissions:
  contents: read
  pages: write
  id-token: write

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

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install package + docs dependencies
        run: |
          python -m pip install --upgrade pip
          # rerandomstats is not on PyPI — install from the v0.2.0 git tag
          # BEFORE the editable install so pip's dependency resolver finds it.
          # Sphinx autodoc imports digimuh modules, which now import from
          # rerandomstats, so the dep is mandatory for the docs build too.
          pip install "git+https://github.com/zerotonin/reRandomStats.git@v0.2.0"
          pip install -e ".[dev]"
          pip install -r docs/requirements.txt

      - name: Build Sphinx documentation
        run: |
          sphinx-build -b html docs/ docs/_build/html

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/_build/html

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4