Fix doc building with numpydoc 0.9 #14029
Merged
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
tacaswell
reviewed
Apr 24, 2019
timhoffm
reviewed
Apr 25, 2019
15d01a9 to
ced8810
Compare
|
I guess you can also delete the bunch of places which have |
timhoffm
approved these changes
Apr 29, 2019
tacaswell
approved these changes
Apr 29, 2019
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Apr 29, 2019
tacaswell
added a commit
that referenced
this pull request
Apr 29, 2019
…029-on-v3.1.x Backport PR #14029 on branch v3.1.x (Fix doc building with numpydoc 0.9)
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.
Fixes #14003
The issue is that adding a
.. noteor.. deprecatedafter some numpydoc sections throws an error. This PR inserts aNotessection if one isn't already present at the bottom of the docstring, which should always be the last section (see https://numpydoc.readthedocs.io/en/latest/format.html), so inserting it at the end of the docstring is fine.