[SciPy-Dev] ipython sphinx directive in docstrings

Alexander Arsenovic arsenovic@virginia....
Sun Jan 6 09:24:30 CST 2013


i recently started using the ipython sphinx directive in my docs.  it seems
to me that using this in the `Examples` section of the docstrings would be
good  practice, as it prevents me from making error in the examples, and
could  be used to insert plots.

from what i see, the  scipy/numpy doc strings dont make use docs use this.
is there a reason why *not* to use the ipython directive in
scipy/numpy-convention docstrings?

alex
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20130106/592315fb/attachment.html 


More information about the SciPy-Dev mailing list