build_docs.yml

# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches:
    - "master"
  pull_request:
    branches:
    - master

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

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

jobs:

  build:
    runs-on: ubuntu-22.04
    container: ghcr.io/scientificcomputing/fenics:2023-08-14
    env:
      DEB_PYTHON_INSTALL_LAYOUT: deb_system
      PUBLISH_DIR: docs/_build/html

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install dependencies
        run: python3 -m pip install ".[docs]"

      - name: Build docs
        run: jupyter book build -W docs

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ${{ env.PUBLISH_DIR }}

  # Single deploy job since we're just deploying
  deploy:
    if: github.ref == 'refs/heads/master'
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Setup Pages
        uses: actions/configure-pages@v2
      
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1