Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Use Napoleon instead of Numpydoc ? #11440

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.

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

Closed
jeremiedbb opened this issue Jul 5, 2018 · 9 comments
Closed

Use Napoleon instead of Numpydoc ? #11440

jeremiedbb opened this issue Jul 5, 2018 · 9 comments
Labels
Documentation Needs Decision - Close Requires decision for closing

Comments

@jeremiedbb
Copy link
Member

Suggested by @GaelVaroquaux , we should use the sphinx extension Napoleon to avoid the Numpydoc dependency.
http://www.sphinx-doc.org/en/stable/ext/napoleon.html
It's used in dirty-cat for example : https://github.com/dirty-cat/dirty_cat

@lesteve
Copy link
Member

lesteve commented Jul 5, 2018

Last time I tried (maybe 1-2 years ago), there were some errors when building the doc with napoleon and it was not immediately obvious how to fix them. Googling at the time, it was not immediately clear what the differences were between napoleon and numpy-doc. There may also be small differences in the doc output that are hard to spot given the size of the scikit-learn documentation.

I would be in favour of waiting for 0.20 before merging a PR that switches to napoleon, so that quirks can be spotted in the dev doc until the 0.21 release.

numpydoc has seen some fixes by @jnothman and @amueller semi-recently (maybe a few months ago) so maybe they have some informed opinion.

@GaelVaroquaux
Copy link
Member

GaelVaroquaux commented Jul 5, 2018 via email

@rth
Copy link
Member

rth commented Jul 5, 2018

I'm also not clear on the differences between the two feature-wise (their documentations are not too explicit about this point), I have used both in the past.

However, another point to consider that is that numpydoc had extensive contributions by Joel (and other scikit-learn developers) while, unless I am mistaken no one contributed to sphinx.ext.napoleon too much.

So this would mean replacing a working and well known dependency, by another one which potentially will require more maintenance work. The end result is that new contributors will not need to install numpydocs when they run tests or build docs locally, but is that worth the effort?

@GaelVaroquaux
Copy link
Member

GaelVaroquaux commented Jul 5, 2018 via email

@jnothman
Copy link
Member

jnothman commented Jul 5, 2018 via email

@jorisvandenbossche
Copy link
Member

What is the original reason to bring this up? Only that napoleon is included in sphinx? Or that we think it actually works better, or is better maintained?

@GaelVaroquaux
Copy link
Member

GaelVaroquaux commented Jul 6, 2018 via email

@cmarmo
Copy link
Contributor

cmarmo commented Jan 17, 2022

Based on how other project have managed similar issues (matplotlib#5743, astropy-sphinx#5) and the effort put in #21350, I believe this one can be closed.

@GaelVaroquaux
Copy link
Member

Sounds good with me. I'm closing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Needs Decision - Close Requires decision for closing
Projects
None yet
Development

No branches or pull requests

7 participants