docs.yaml

name: deploy-documentation

# Only run this when the master branch
on:
  push:
    branches:
      - master
      - develop
      - feature/sphinx
  # Option to run action manually
  workflow_dispatch:
    inputs:
      tag:
        description: Tag for manually deploying docs website
        required: False
        default: ""
permissions:
  contents: write

# This job installs dependencies, builds the documentaiton, and pushes it to `gh-pages`
jobs:
  deploy-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python 3.8
        uses: actions/setup-python@v2
        with:
          python-version: 3.8
      - name: Install dependencies
        run: |
          pip install -e .[docs]
      - name: Build the documentation
        run: |
          cd docs
          make html
          touch _build/html/.nojekyll
      - name: Deploy documentation
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          folder: docs/_build/html
          token: ${{ secrets.GH_PAGES }}