Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

View reStructuredText (Sphinx) docstrings in iPython?

Is there a way to have IPython fully render reStructuredText (for Sphinx) docstrings when you type the following:

help foo

or:

foo?

I find it super distracting to try to read help docs in IPython when it shows the raw markup. reST is great for Sphinx documentation, but really clutters up simple help lookups. I can't be alone on this one...?

Google has been no help on this one.

like image 868
jkmacc Avatar asked Jan 24 '12 20:01

jkmacc


1 Answers

I don't think it is possible in IPython, but have a look at Spyder: You can open an IPython console from within the IDE. Docstrings are rendered as HTML.

like image 160
bmu Avatar answered Nov 15 '22 14:11

bmu