Skip to content

Commit

Permalink
Build docs in CI, including sphinx-lint.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaraco committed Dec 18, 2022
1 parent c68ac3b commit 82465b9
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,28 @@ jobs:
- name: Run tests
run: tox

docs:
runs-on: ubuntu-latest
env:
TOXENV: docs
steps:
- uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python }}${{ matrix.dev }}
- name: Install tox
run: |
python -m pip install tox
- name: Run tests
run: tox

check: # This job does nothing and is only used for the branch protection
if: always()

needs:
- test
- docs

runs-on: ubuntu-latest

Expand Down
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ docs =
jaraco.packaging >= 9
rst.linker >= 1.9
furo
sphinx-lint

# local

Expand Down
1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ extras =
changedir = docs
commands =
python -m sphinx -W --keep-going . {toxinidir}/build/html
python -m sphinxlint

[testenv:release]
skip_install = True
Expand Down

0 comments on commit 82465b9

Please sign in to comment.