Use napolean extension in docs to handle numpy docstrings too #3871
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
|
closes #3841 |
bjlittle
approved these changes
Sep 22, 2020
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Sep 22, 2020
* master: Use napolean extension in docs to handle numpy docstrings too (SciTools#3871) Added whats new for pr3873 (SciTools#3874)
Merged
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Sep 22, 2020
* master: Use napolean extension in docs to handle numpy docstrings too (SciTools#3871) Added whats new for pr3873 (SciTools#3874) linkcheck ignore for iris pull and issue url (SciTools#3873) Remove all local table of contents (SciTools#3872) Added whats new entry for pr3852 (SciTools#3854)
Closed
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.
🚀 Pull Request
Description
This PR enables adoption (but does not force) of numpy docstrings. This solves #3841
Enabling napolean sphinx extension to allow for google style docstrings and now also numpy style docstrings.
Just by enabling this extension causes build warnings due to existing incorrectly formatted docstrings. A couple of files needed to be updated to allow for a clean build.
lib/iris/io/__init__.py- Correct formatting is now applied when rendered.lib/iris/analysis/maths.py- Fix build warningThe
requirements/ci/py37.ymlandpy36.ymlhave been updated to include the new dependency for this extension.Note that the documentation now will also include all dunders, you can search for dunders via:
The setting named napoleon_include_special_with_doc can change this (currently set to True) in
conf.py.Note that the links to the This PR is only valid for the lifetime of this PR.
Consult Iris pull request check list