Skip to content
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

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

Open
argriffing opened this issue Dec 8, 2014 · 3 comments
Open

Comments

@argriffing
Copy link

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?

@WeatherGod
Copy link
Member

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
#11.

@argriffing
Copy link
Author

@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.

@tacaswell
Copy link
Member

I vote for (2).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants