Docs checks #1053
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Docs checks | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| schedule: | |
| # run every Monday at 6am UTC | |
| - cron: '0 6 * * 1' | |
| env: | |
| SETUP_XVFB: True # avoid issues if mpl tries to open a GUI window | |
| TOXARGS: '-v' | |
| jobs: # This job is used to check that the documentation builds correctly. | |
| ci-tests: | |
| name: ${{ matrix.tox_env }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - os: ubuntu-latest | |
| python: '3.10' | |
| tox_env: 'build_docs' | |
| - os: ubuntu-latest | |
| python: '3.10' | |
| tox_env: 'linkcheck' | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| with: | |
| submodules: true | |
| - name: Check out that no sensitive environment variable is shared | |
| run: env | |
| - name: Set up Python ${{ matrix.python }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Install base dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install tox | |
| - name: Install system dependencies | |
| run: sudo apt-get -y install graphviz pandoc | |
| - name: Print Python, pip, setuptools, and tox versions | |
| run: | | |
| python -c "import sys; print(f'Python {sys.version}')" | |
| python -c "import pip; print(f'pip {pip.__version__}')" | |
| python -c "import setuptools; print(f'setuptools {setuptools.__version__}')" | |
| python -c "import tox; print(f'tox {tox.__version__}')" | |
| - name: Run tests | |
| run: tox -e ${{ matrix.tox_env }} |