Skip to content

Commit 82465b9

Browse files
committed
Build docs in CI, including sphinx-lint.
1 parent c68ac3b commit 82465b9

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

.github/workflows/main.yml

+17
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,28 @@ jobs:
7272
- name: Run tests
7373
run: tox
7474

75+
docs:
76+
runs-on: ubuntu-latest
77+
env:
78+
TOXENV: docs
79+
steps:
80+
- uses: actions/checkout@v3
81+
- name: Setup Python
82+
uses: actions/setup-python@v4
83+
with:
84+
python-version: ${{ matrix.python }}${{ matrix.dev }}
85+
- name: Install tox
86+
run: |
87+
python -m pip install tox
88+
- name: Run tests
89+
run: tox
90+
7591
check: # This job does nothing and is only used for the branch protection
7692
if: always()
7793

7894
needs:
7995
- test
96+
- docs
8097

8198
runs-on: ubuntu-latest
8299

setup.cfg

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ docs =
5252
jaraco.packaging >= 9
5353
rst.linker >= 1.9
5454
furo
55+
sphinx-lint
5556

5657
# local
5758

tox.ini

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ extras =
2020
changedir = docs
2121
commands =
2222
python -m sphinx -W --keep-going . {toxinidir}/build/html
23+
python -m sphinxlint
2324

2425
[testenv:release]
2526
skip_install = True

0 commit comments

Comments
 (0)