use the numpydoc package instead of bundling a numpydoc.py file
argriffing opened this issue · 3 comments
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?
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 notifications@github.com 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
#11.
@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 #10 is merged to avoid git conflicts.
I vote for (2).