docs.yml

name: Documentation

on:
  push:
    branches: ["docs"]
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'

  workflow_dispatch:

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

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    container:
       image: sphinxdoc/sphinx

    steps:
      - name: Checkout latest
        uses: actions/checkout@v3
      - name: Additional python packages
        run: pip3 install myst_parser sphinx_rtd_theme
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Build html
        run: |
          cd docs
          make html
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./docs/_build/html
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2