docs.yml

# Build and deploy sphinx documentation to GitHub Pages
name: docs

on:
  push:
    branches:
      - main
    paths:
      - "src/**"
      - "docs/**"
      - "pyproject.toml"
      - "poetry.lock"
      - "poetry.toml"
      - "!**.md"
      - "!.github/workflows/ci.yml"
  pull_request:
    paths-ignore:
      - "**.md"

  workflow_dispatch:

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout project
        uses: actions/checkout@v3

      - name: Install Python
        uses: actions/setup-python@v3
        with:
          python-version: "3.9"

      - name: Install R
        uses: r-lib/actions/setup-r@v2
        with:
          r-version: "release"

      - name: Install spatstat subpackages and extensions
        run:
          Rscript -e 'install.packages(c("spatstat.explore", "spatstat.geom"))'

      - name: Install Poetry
        uses: snok/install-poetry@v1
        # with:
        #   virtualenvs-create: true
        #   virtualenvs-in-project: true

      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v3
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}

      - name: Install package with main (non-optional) and docs dependencies
        # see [tool.poetry.dependencies] and [tool.poetry.extras]
        # in pyproject.toml
        run: poetry install -E docs

      - name: Build docs with sphinx
        run: poetry run sphinx-build -b html docs docs/_build/html

      - name: Deploy documentation to gh-pages branch
        uses: s0/git-publish-subdir-action@develop
        env:
          REPO: self
          BRANCH: gh-pages
          FOLDER: docs/_build/html
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}