build_and_deploy_documentation.yml

name: Build and deploy documentation

on: [push, pull_request, workflow_dispatch]

permissions:
  contents: write

jobs:
  build-and-deploy-documentation:
    name: Build and Deploy Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
      - name: Install dependencies
        run: |
          pip install sphinx sphinx_rtd_theme myst_parser
      - name: Build and deploy documentation
        run: |
          sphinx-build -M html documentation/source documentation/build
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.event_name == 'push'}}
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: documentation/build/html
          force_orphan: true
          publish_branch: gh-pages