deploy-docs.yml

name: Documentation
on:
  push:
    branches: [main]
  pull_request:

jobs:
  docs:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2

      - name: Install dependencies
        run: pip install nox

      - name: Generate documentation
        run: nox -s docs

      - name: Upload to GitHub Pages
        if: github.ref == 'refs/heads/main' && github.repository == 'pradyunsg/furo'
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./build/docs/