Improve documentation content and building#212
Open
stanwest wants to merge 9 commits intoxgcm:masterfrom
Open
Conversation
Resolves messages such as "SyntaxWarning: invalid escape sequence '\m'" that can appear in tracebacks and when building the documentation. Corrects math expressions in docstrings for `cross_phase` (changing math "extArg" to text "Arg") and for `isotropic_cross_spectrum`, `isotropic_power_spectrum`, and `isotropize` (changing math "extiso" to text "iso").
Also resolves the message "WARNING: Inline strong start-string without end-string. [docutils]" when building documentation.
Extend a title underline to the correct length, separate a bulleted list
with blank lines, and indent the content of math directives. Corrects
the rendering of the "mode" argument of `padding.pad` and of the
equations under `xrft.power_spectrum`. Resolves the following messages
when building the documentation:
doc/whats-new.rst:
* WARNING: Title underline too short.
xrft/padding.py:
* ERROR: Unexpected indentation.
* WARNING: Block quote ends without a blank line; unexpected
unindent.
xrft/xrft.py:
* WARNING: Explicit markup ends without a blank line; unexpected
unindent.
Corrects the rendering of the "issue" directives in "doc/whats-new.rst" and resolves the message 'ERROR: Unknown interpreted text role "issue".' when building the documentation.
Resolves the message "WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English)." when building the documentation.
Resolves the message "WARNING: html_static_path entry '_static' does not exist" when building the documentation.
Format keyword arguments more consistently and correct spelling.
Resolves the message "WARNING: No 'apidoc_module_dir' specified; skipping API doc generation" that appears when building the documentation.
Author
|
The most recent commit resolves the last warning message that I encounter:
|
Closed
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
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.
This pull request corrects and improves the content of the documentation and resolves several warnings and errors that appear when building the documentation.
The main content changes are as follows:
cross_phase(changing math "extArg" to text "Arg") and forisotropic_cross_spectrum,isotropic_power_spectrum, andisotropize(changing math "extiso" to text "iso").xrft.power_spectrum.padding.pad.padding.unpadinto the "Parameters" section from the "Returns" section.issuedirectives in "doc/whats-new.rst".The resolved messages include:
SyntaxWarning: invalid escape sequence '\m'WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).WARNING: html_static_path entry '_static' does not existWARNING: Explicit markup ends without a blank line; unexpected unindent.ERROR: Unexpected indentation.WARNING: Block quote ends without a blank line; unexpected unindent.WARNING: Inline strong start-string without end-string.WARNING: Title underline too short.ERROR: Unknown interpreted text role "issue".