Check docs in CI #35
Workflow file for this run
This file contains 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: tests | |
on: [push] | |
jobs: | |
test: | |
name: Run tests with pytest | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: ['3.8', '3.9', '3.10', '3.11', '3.12'] | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install dependencies | |
run: | | |
pip install pip-tools | |
pip-sync requirements/requirements.txt requirements/requirements-test.txt | |
- name: Test with tox | |
run: tox | |
docs: | |
name: Build and check documentation | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python 3.12 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.12' | |
- name: Install dependencies | |
run: | | |
pip install pip-tools | |
pip-sync requirements/requirements.txt requirements/requirements-docs.txt | |
- name: Lint docs with sphinx-lint | |
run: | | |
sphinx-lint docs | |
- name: Build docs and check the integrity of external links | |
run: | | |
ls source | |
sphinx-build --builder linkcheck --fail-on-warning "source" "build" | |
sphinx-build --builder html --fail-on-warning "source" "build" | |
working-directory: | |
./docs |