Reduce sphinx warnings #2221
Merged
Reduce sphinx warnings #2221
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
|
Okay, now there are several 'Inline emphasis start-string without end-string' warnings from parsing img_nest.py, such as from |
|
Those should be wrapped in double backticks for code styling. |
|
Done. Thanks @QuLogic! |
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.
Rationale
As @greglucas pointed out in #2220, the CI server shows some warnings while building the docs. Running on a newer version of sphinx (v7.0.1), there is also a warning in GeoSpine.set_position from a link in the inherited docstring. These are addressed here. Some more broken cross-references were also found/cleaned up by looking at the output of sphinx in nitpicky mode.
Notes
This adds the :module: tag to all modules (including sub-modules), so they can be cross-referenced. Previously I had only changed this for the main the top-level modules, which is why there was still a warning about not finding the SRTM modules.
A class.rst template is created, which is used by default. Without this, the methods within a class were not generating HTML anchors that can be linked to, other than in the matplotlib and crs modules where a template was already explicitly used.
Sphinx version <6 needed to be pinned in docs/doc-requirements.txt (DOC: Pin Sphinx less than version 6 #2131), but I think this not needed now due to Standardize logo image behavior between Sphinx and this theme pydata/pydata-sphinx-theme#1132
Implications
Improved cross-referencing throughout the docs.