build_docs.yml

name: build_docs

on: [push, pull_request, workflow_dispatch]

permissions:
  contents: write

jobs:
  build_docs:
    runs-on: ubuntu-latest
    env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v3
      - name: Install dependencies
        run: |
          pip install sphinx sphinx_rtd_theme myst_parser
      - name: Sphinx build
        run: |
          cd docs
          make clean
          make html
          cd _build
          touch .nojekyll
          git init
          git add -A
          git config --local user.email "malcolmgti@gmail.com"
          git config --local useer.name "GitHub Action"
          git commit -m 'deploy'
      - name: Deploy to GitHub Pages, force push to destination branch
        uses: ad-m/github-push-action@v0.5.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: ./docs/_build/html
          force: true
          force_orphan: true