Doc update: config.rst bugfixes and formatting #272
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
This patch fixes some errors in the config.rst documentation file: - A code block was missing its leading blank line - Some double-quote (``) works were using triple-quotes Some formatting changes were also made: - Trailing whitespace was removed - Column width (79) was consistently appled across the file. Finally, a typo was fixed (defaul -> default).
We do not use html_static_path even though this configuration was enabled. This was causing a warningdue to the absence of the directory. This patch removes the configuration, and the warning.
|
Hello @marshallward! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:
Comment last updated at 2020-06-18 03:23:15 UTC |
Labels for `usage` and `manifest` appear to be unncessary, since Sphinx automatically uses the document name to assign those labels. Removing them appears to eliminate the duplicate label warning from Sphinx.
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.
This patch fixes some errors in the config.rst documentation file:
A code block was missing its leading blank line
Some double-quote (``) works were using triple-quotes
Some formatting changes were also made:
Trailing whitespace was removed
Column width (79) was consistently appled across the file.
Finally, a typo was fixed (defaul -> default).