Reducing the number of warnings when building docs #1769
Merged
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.
What is the change?
This PR mainly includes minor fixes to reduce errors/warnings during the documentation build. Here are a list of things included:
A more significant change includes modifications to the
dochelpers
package. This includes:Why is the change being made?
This somewhat of a "basic" maintenance PR: making docs render properly. On a more practical level, reducing the number of warnings when building docs helps pick out future bugs written in the documentation.
Checklist
doc
folder.pyproject.toml
.