Skip to content

Move from numpydoc to sphinxcontrib-napoleon #5731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
mdboom opened this issue Dec 23, 2015 · 5 comments
Closed

Move from numpydoc to sphinxcontrib-napoleon #5731

mdboom opened this issue Dec 23, 2015 · 5 comments
Assignees
@QuLogic
Labels
Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation

Comments

@mdboom
Copy link
Member

mdboom commented Dec 23, 2015

napoleon is a more general replacement for numpydoc docstring support and ships with Sphinx since 1.3.

There seem to be subtle differences, however, and so it will take some manual updating to our docstrings to get this to work.
@mdboom mdboom added Documentation low hanging fruit Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues labels Dec 23, 2015
@tacaswell tacaswell added this to the next major release (2.0) milestone Dec 23, 2015
@QuLogic
Copy link
Member

QuLogic commented Dec 24, 2015

Google or NumPy style? There are some inconsistencies in at least axes/_axes.py that are causing it to choke.

@tacaswell
Copy link
Member

We should definitely stick with numpydoc style (and put in the effort to pull all of our docstrings up to standards).

@QuLogic QuLogic self-assigned this Dec 24, 2015
@QuLogic QuLogic mentioned this issue Dec 24, 2015
Closed
@mdboom
Copy link
Member Author

mdboom commented Dec 29, 2015

Just a ditto for Numpydoc style -- that's the more prevalent one in the "scipy ecosystem". Though my sense of napoleon is that it's a bit stricter than numpydoc and will probably find some problems in our docstrings.

@mdboom mdboom modified the milestones: proposed next point release (2.1), next major release (2.0) Jan 25, 2016
@tacaswell tacaswell modified the milestones: 2.1 (next point release), 2.2 (next next feature release) Oct 3, 2017
@dstansby
Copy link
Member

I think we're pretty much using numpydoc everywhere now, so I'll close this. Feel free to re-open if I'm wrong.

@QuLogic
Copy link
Member

QuLogic commented Feb 15, 2018

This is about using the Sphinx-provided napoleon extension instead of the external numpydoc one; I don't know if we still want to do that.

@story645 story645 removed this from the future releases milestone Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@QuLogic QuLogic

Labels
Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: Use napoleon sphinx extension QuLogic/matplotlib
5 participants
@mdboom @tacaswell @QuLogic @story645 @dstansby