Fix doc building with numpydoc 0.9 by dstansby · Pull Request #14029 · matplotlib/matplotlib · GitHub
Skip to content

Fix doc building with numpydoc 0.9 - #14029

Merged
anntzer merged 4 commits into
matplotlib:masterfrom
dstansby:numpydoc-point9
Apr 29, 2019
Merged

anntzer merged 4 commits into
matplotlib:masterfrom
dstansby:numpydoc-point9

Conversation

@dstansby

Copy link
Copy Markdown
Member

Fixes #14003

The issue is that adding a .. note or .. deprecated after some numpydoc sections throws an error. This PR inserts a Notes section 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.

Comment thread lib/matplotlib/cbook/deprecation.py Outdated
@tacaswell tacaswell added this to the v3.1.0 milestone Apr 24, 2019
Comment thread lib/matplotlib/cbook/deprecation.py Outdated
@anntzer

anntzer commented Apr 28, 2019

Copy link
Copy Markdown
Contributor

@anntzer anntzer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

post-ci

@timhoffm timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve, but don't merge myself because I have a commit in this.

@anntzer
anntzer merged commit de957a9 into matplotlib:master Apr 29, 2019
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Apr 29, 2019
@dstansby
dstansby deleted the numpydoc-point9 branch April 29, 2019 19:18
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

numpydoc 0.9 breaks doc build

4 participants