Fix documentation build warnings (#1484) #1620
Open
Conversation
This file contains hidden or 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
This commit addresses all the warnings reported when running `tox -e docs`: 1. Fixed title underlines in settings.rst that were too short: - OIDC_RP_INITIATED_LOGOUT_ENABLED - OIDC_RP_INITIATED_LOGOUT_STRICT_REDIRECT_URIS - OIDC_RP_INITIATED_LOGOUT_ACCEPT_EXPIRED_TOKENS 2. Fixed unexpected indentation in contributing.rst by adding a colon before the code block 3. Fixed unexpected indentation in oidc.rst by converting inline code blocks (::) to proper code-block directives at lines 292 and 336 4. Fixed unknown interpreted text role ':openid:' in AbstractIDToken docstring by replacing it with plain text reference to OpenID Connect specification 5. Fixed duplicate object descriptions between views/details.rst and views/mixins.rst by adding :noindex: directive to details.rst 6. Fixed code block lexer warning in management_commands.rst by changing the language from 'sh' to 'text' for the usage output
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes all Sphinx documentation build warnings by correcting RST formatting issues: title underlines, code block directives, undefined role reference, and duplicate object descriptions.
Fixes #1484