Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

turn doc build warnings into errors #1724

Merged
merged 4 commits into from
Dec 16, 2021
Merged

turn doc build warnings into errors #1724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7ab104
turn doc build warnings into errors
Dec 13, 2021
9955c1a
Add the fail on warning to the readthedocs conf
Dec 14, 2021
4187494
Simplify the tox envlist and add docs
Dec 14, 2021
7dc5940
update CONTRIBUTORS.rst related to tox
Dec 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: []
Expand Down
7 changes: 3 additions & 4 deletions docs/CONTRIBUTORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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