Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ReadTheDocs hasn't built the documentation in over a year.
To help ensure that the documentation can build cleanly, this PR introduces a new tox build environment,
docs
, which tests that the documentation can build.It also fixes a single warning issued by the new doc tests:
Note
While working on this, it became clear that
tox.ini
is not maintained (Python 2.7 and 3.6 are the only defined Python versions to test). This can be addressed in a separate PR.Also, it is strongly recommended that
doc/requirements.txt
pin exact dependency versions.This PR does not address build reproducibility; it simply introduces testing of the documentation builds.