diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 66dc234b..7e568497 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -11,6 +11,7 @@ on: - "setup.*" - "src/**/*" - "tests/*.py" + - "docs/**/*" jobs: lint: @@ -56,3 +57,20 @@ jobs: run: python -m pip install tox - name: Test run: python -m tox -e py + + docs: + name: Test documentation builds + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + ref: ${{ github.event.inputs.branch }} + - name: Use Python 3.10 + uses: actions/setup-python@v2 + with: + python-version: "3.10" + - name: Install test dependencies + run: python -m pip install tox + - name: Test + run: python -m tox -e docs diff --git a/AUTHORS b/AUTHORS index b0bb951b..de94646c 100644 --- a/AUTHORS +++ b/AUTHORS @@ -17,6 +17,7 @@ Gary van der Merwe Gora Khargosh Hannu Valtonen Jesse Printz +Kurt McKee Léa Klein Luke McCarthy Lukáš Lalinský diff --git a/changelog.rst b/changelog.rst index b9f7440a..69a1d335 100644 --- a/changelog.rst +++ b/changelog.rst @@ -8,8 +8,8 @@ Changelog 2022-xx-xx • `full history `__ -- -- Thanks to our beloved contributors: @ +- [documentation] HTML documentation builds are now tested for errors. +- Thanks to our beloved contributors: @kurtmckee 2.1.9 ~~~~~ diff --git a/docs/source/installation.rst b/docs/source/installation.rst index bed272b5..b814976a 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -14,7 +14,7 @@ Installing from PyPI using pip $ python -m pip install -U |project_name| # or to install the watchmedo utility: - $ python -m pip install -U |project_name|[watchmedo] + $ python -m pip install -U |project_name|\[watchmedo] Installing from source tarballs ------------------------------- diff --git a/requirements-tests.txt b/requirements-tests.txt index 6e2bd348..645784c0 100644 --- a/requirements-tests.txt +++ b/requirements-tests.txt @@ -6,3 +6,4 @@ flaky pytest pytest-cov pytest-timeout +sphinx diff --git a/tox.ini b/tox.ini index 34dca6ef..3f1d6f1a 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py{311,310,39,38,37,36,py3} +envlist = py{311,310,39,38,37,36,py3}, docs skip_missing_interpreters = True [testenv] @@ -15,3 +15,10 @@ deps = -r requirements-tests.txt commands = python -m flake8 docs tools src tests setup.py + +[testenv:docs] +usedevelop = true +deps = + -r requirements-tests.txt +commands = + sphinx-build -aEWb html docs/source docs/build/html