ipython notebooks in the sphinx documentation

[krastano...@gmail.com]

Is there a _right_ way to use ipython notebooks as part of the sphinx
documentation?

It was mentioned here
http://mail.scipy.org/pipermail/ipython-user/2011-December/008901.html
and here http://mail.scipy.org/pipermail/ipython-user/2011-December/008928.html
and here http://code.google.com/p/sympy/issues/detail?id=2940

But there is no code for the html (or better sphinx) export.

I am asking as most of the examples for the plotting module are in the
form of ipython notebooks.

[Aaron Meurer]

Those were about using the notebooks for the examples (the examples/
directory). We've yet to have a real solution to that, partly because
of a lack of work on our part, and partly because of a lack of
features in the notebook (such as doctesting and automatic html
export).

For putting it in Sphinx, I have no idea how to do that. You should
ask on the IPython list about it.

If you just want to include a notebook, I guess just put it in with
the examples. We will have to clean it up when we fix issue 2940.
Maybe we should just work up a simple html/pdf export script (I think
it's doable) and convert our examples to the notebook, forgoing ease
of testing for now (we can run through them before releasing to make
sure they work).

Anyone want to do this? It would make a good GSoC patch :)

Aaron Meurer

> --
> You received this message because you are subscribed to the Google Groups "sympy" group.
> To post to this group, send email to sy...@googlegroups.com.
> To unsubscribe from this group, send email to sympy+un...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/sympy?hl=en.
>

[Bharath M R]

I think the ipython directive (http://matplotlib.sourceforge.net/sampledoc/ipython_directive.html) 

can be used to run the ipython notebook and render the outputs statically. I think this is what 

you want. 

[Aaron Meurer]

This lets you include IPython style prompts in the Sphinx docs. As
far as I can tell, it doesn't let you do anything with respect to the
notebook.

Aaron Meurer

> --
> You received this message because you are subscribed to the Google Groups
> "sympy" group.

> To view this discussion on the web visit
> https://groups.google.com/d/msg/sympy/-/27w1oTocsqsJ.