.github/workflows/doc.yml

   1 name: Documentation
   2
   3 on: [push, pull_request]
   4
   5 permissions:
   6   contents: read
   7
   8 jobs:
   9   build:
  10     # We want to run on external PRs, but not on our own internal PRs as they'll be run
  11     # by the push to the branch. Without this if check, checks are duplicated since
  12     # internal PRs match both the push and pull_request events.
  13     if:
  14       github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
  15       github.repository
  16
  17     strategy:
  18       fail-fast: false
  19       matrix:
  20         os: [ubuntu-latest, windows-latest]
  21
  22     runs-on: ${{ matrix.os }}
  23     steps:
  24       - uses: actions/checkout@v3
  25
  26       - name: Set up latest Python
  27         uses: actions/setup-python@v4
  28         with:
  29           python-version: "*"
  30
  31       - name: Install dependencies
  32         run: |
  33           python -m pip install --upgrade pip setuptools wheel
  34           python -m pip install -e ".[d]"
  35           python -m pip install -r "docs/requirements.txt"
  36
  37       - name: Build documentation
  38         run: sphinx-build -a -b html -W --keep-going docs/ docs/_build