sampledoc icon indicating copy to clipboard operation
sampledoc copied to clipboard

use the numpydoc package instead of bundling a numpydoc.py file

Open argriffing opened this issue 10 years ago • 3 comments
trafficstars

numpydoc is now its own project which can be installed with pip or other OS/distribution package managers. Would make sense to remove sphinxext/numpydoc.py from sampledoc?

argriffing avatar Dec 08 '14 20:12 argriffing

It might be valuable to have a note about how to do that, but I think the purpose of sampledoc is not to show off numpydoc, but rather how to get up and running with sphinx for your own project.

On Mon, Dec 8, 2014 at 3:53 PM, argriffing [email protected] wrote:

numpydoc https://github.com/numpy/numpydoc is now its own project which can be installed with pip or other OS/distribution package managers. Would make sense to remove sphinxext/numpydoc.py from sampledoc?

— Reply to this email directly or view it on GitHub https://github.com/matplotlib/sampledoc/issues/11.

WeatherGod avatar Dec 08 '14 22:12 WeatherGod

@WeatherGod I think that using a numpydoc.py file in the sphinxext directory, as sampledoc currently does, is an obsolete and unsupported way to use numpydoc. If there are three options 1) keep numpydoc.py in sphinxext 2) use the numpydoc package 3) remove numpydoc entirely from sampledoc, then I'd think (2) or (3) would be better than (1), right?

In either case I could add a PR, but because it affects the extensions list I'd wait until https://github.com/matplotlib/sampledoc/pull/10 is merged to avoid git conflicts.

argriffing avatar Dec 08 '14 22:12 argriffing

I vote for (2).

tacaswell avatar Dec 09 '14 15:12 tacaswell