Make docs build stricter #1148
Merged
Make docs build stricter #1148
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With this commit we treat warnings as errors when building docs with `make docs`. We also remove the obsolete docs configuration from tox as documentation should only be built via the make target. Finally, we upgrade the RTD theme to its latest version to avoid `RemovedInSphinx30Warning` when building docs.
danielmitterdorfer
added
enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
With this commit we treat warnings as errors when building docs with
make docs. We also remove the obsolete docs configuration from tox asdocumentation should only be built via the make target. Finally, we
upgrade the RTD theme to its latest version to avoid
RemovedInSphinx30Warningwhen building docs.