docs: fix sphinx warnings #1818
Merged
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
aucampia
force-pushed
the
iwana-20220414T2246-sphinx_warnings
branch
2 times, most recently
from
6693e2f
to
8a6cf34
Compare
This patch fixes all sphinx warnings and also changes sphinx building to treat warnings as errors so that we don't introduce new warnings. Also: - ci: fail on sphinx warnings. - ci: don't use GitHub actions to build docs as this is being done by readthedocs.org. - build: supress "more than one target found for cross-reference" warnings from sphinx autodoc.
aucampia
force-pushed
the
iwana-20220414T2246-sphinx_warnings
branch
from
8a6cf34
to
8c65e6c
Compare
aucampia
requested review from
ashleysommer,
a user,
white-gecko and
nicholascar
ghost
approved these changes
Apr 15, 2022
nicholascar
approved these changes
Apr 15, 2022
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.
Summary of changes
This patch fixes all sphinx warnings and also changes sphinx building to
treat warnings as errors so that we don't introduce new warnings.
Also:
readthedocs.org.
warnings from sphinx autodoc.
Checklist
Checked that there aren't other open pull requests for
the same change.
NOTE: This is fixing a warning which is also fixed in Bind prefixes choices #1686 - though it should merge fine hopefully as the fixed source should be the same.
Checked that all tests and type checking passes.
Considered granting push permissions to the PR branch,
so maintainers can fix minor issues and keep your PR up to date.