Merge pull request #1724 from kairoaraujo/doc_warnings_to_errors

turn doc build warnings into errors
theupdateframework · Dec 16, 2021 · 3823fd6 · 3823fd6
2 parents febe6c3 + 7dc5940
commit 3823fd6
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -9,6 +9,7 @@ version: 2
 sphinx:
    builder: html
    configuration: docs/conf.py
+   fail_on_warning: true
 
 # Optionally build your docs in additional formats such as PDF
 formats: []

diff --git a/docs/CONTRIBUTORS.rst b/docs/CONTRIBUTORS.rst
@@ -184,10 +184,9 @@ a *venv*), and then install ``securesystemslib`` in editable mode too (in the sa
     $ python3 -m pip install -r requirements-dev.txt
 
 
-With `tox <https://testrun.org/tox/>`_ the test suite can be executed in a
-separate *venv* for each supported Python version. While the supported
-Python versions must already be available, ``tox`` will install ``tuf`` and its
-dependencies anew in each environment.
+With `tox <https://testrun.org/tox/>`_, the test suite can be executed in a
+separate *venv*. While a supported Python version must already be available,
+``tox`` will install ``tuf`` and dependencies.
 ::
 
     $ tox

diff --git a/tox.ini b/tox.ini
@@ -4,7 +4,7 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = lint,py{36,37,38,39,310}
+envlist = lint,docs,py
 skipsdist = true
 
 [testenv]
@@ -59,4 +59,4 @@ deps =
 
 changedir = {toxinidir}
 commands =
-    sphinx-build -b html docs docs/build/html
+    sphinx-build -b html docs docs/build/html -W