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

Deprecate our IPython-related Sphinx directives #2062

Closed
mdboom opened this issue May 24, 2013 · 3 comments
Closed

Deprecate our IPython-related Sphinx directives #2062

mdboom opened this issue May 24, 2013 · 3 comments
Milestone

Comments

@mdboom
Copy link
Member

mdboom commented May 24, 2013

Once ipython/ipython#3352 is merged and has made it into a release, we should deprecate our copies of the ipython sphinx directives.

@WeatherGod
Copy link
Member

Just a thought, if we got rid of the ipython sphinx directives, how will the docs build on systems without ipython? They do exist, for example build machines, or someone just simply looking at the pre-reqs.

@pelson
Copy link
Member

pelson commented May 24, 2013

lib/matplotlib/sphinxext/ipython_directive.py depends on IPython. Though I admit that lib/matplotlib/sphinxext/ipython_console_highlighting.py doesn't.

It just feels like we're stamping on some toes by having IPython helpers in the matplotlib source. Their home really should be in the IPython core (or some spin-off package).

@mdboom
Copy link
Member Author

mdboom commented May 24, 2013

Yeah -- the ipython_directive was written by John Hunter, so I think it just started life in matplotlib, though it probably shouldn't have. It isn't a requirement of matplotlib's documentation build.

ipython_console_highlighting doesn't depend on IPython, but it probably logically belongs in IPython. Though I understand the need to keep the matplotlib build from depending on IPython. In that case, perhaps we should move it to our private sphinx extension directory (i.e. not install it), and encourage third-party users of the extension to get it from IPython.

@mdboom mdboom closed this as completed Sep 3, 2013
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