.github/workflows/doc.yml

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