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.
This adds a code style check to avoid unexpectedly shipping docs/docstrings which cause issues.
Options (the long names are only part of the upcoming 7.3 release), based upon https://www.sphinx-doc.org/en/master/man/sphinx-build.html:
-n
: Report warnings for missing references.-W
: Turn warnings into errors and stop at first violation.--keep-going
: Improve-W
by collecting all violations and only failing at the end.-T
: Display the full traceback on actual errors.-b html
: Build HTML pages.docs
: Source directory.build/sphinx/html
: Target directory.Fixes #2402.