documentation.yml

name: Docs
on: [push, workflow_dispatch]
jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: '3.9'
      - name: Extract branch name
        shell: bash
        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
        id: extract_branch
      - name: Install dependencies
        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main') }}
        run: |
          pip install -r requirements.txt
          pip install sphinx sphinx_rtd_theme myst-parser
      - name: Sphinx build
        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main') }}
        run: |
          sphinx-build -b html docs/source docs/build/html -E -a
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main') }}
        with:
          publish_branch: gh-pages
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: docs/build/html
          force_orphan: true