docs.yml

name: Build and publish docs

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
    steps:
      - name: Checkout Source
        uses: actions/checkout@v2
        with:
          # require all of history to see all tagged versions' docs
          fetch-depth: 0

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: 3.8

      - name: Install Dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install -r docs-requirements.txt
          python setup.py build
          python setup.py install

      - name: Checkout gh-pages
        # As we already did a deploy of gh-pages above, it is guaranteed to be there
        # so check it out so we can selectively build docs below
        uses: actions/checkout@v2
        with:
          ref: gh-pages
          path: docs/_build

      - name: Test Build Docs
        if: github.ref != 'refs/heads/main' && ! startsWith(github.ref, 'refs/tags')
        run: |
          BUILDDIR=_build/main make -C docs/ local

      - name: Build Docs
        if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags')
        # Use the args we normally pass to sphinx-build, but run sphinx-multiversion
        run: |
          make -C docs/ html
          touch docs/_build/.nojekyll
          cp docs/redirect.html docs/_build/index.html

      - name: Publish Docs to gh-pages
        # Only once from main or a tag
        if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags')
        # We pin to the SHA, not the tag, for security reasons.
        # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
        uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501  # v3.7.3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: docs/_build
          keep_files: true