sphinx-to-gh-pages.yaml

# GitHub Actions workflow to build HTML site via Sphinx and deploy it
# to github.io via the gh-pages branch
#
# Primarily based on https://github.com/marketplace/actions/sphinx-docs-to-github-pages

name: Sphinx website to gh-pages

on:
  push:
    branches:
      - main

jobs:
  sphinx_website_to_gh-pages:
    name: Sphinx website to gh-pages
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Conda environment with Micromamba
        uses: mamba-org/setup-micromamba@e820223f89c8720d6c740ca154a7adf32fcd278a
        with:
           environment-file: envs/environment-gh-pages.yaml
           environment-name: numeric-gh-pages
           # persist downloads and environment caches for 1 day
           cache-downloads-key: downloads-${{ steps.date.outputs.date }}
           cache-environment-key: environment-${{ steps.date.outputs.date }}

      - name: Sphinx build and deploy
        uses: uibcdf/action-sphinx-docs-to-gh-pages@v1.0-beta.2
        with:
          branch: main
          dir_docs: website
          sphinxopts: ''