Hi Jon,<br><br>So, there&#39;s different bits of IPython. In the terminal, we&#39;re quite limited in what we can do - most modern terminals let us change the colour of text, or make it slightly bold. It would be possible to do some rendering of reST here (e.g. convert *emphasis* to bold text), but it&#39;s very limited; especially with links (which I think are the most disruptive thing for reading raw reST), you can&#39;t hide the URL.<br>

<br>In the Qt console and now the HTML notebook, the situation is much better - you could render the reST to HTML for the frontend to display.<br><br>A command like zip? is translated to get_ipython().magic(u&#39;pinfo zip&#39;) , which calls the magic_pinfo function:<br>

<a href="https://github.com/ipython/ipython/blob/master/IPython/core/magic.py#L541">https://github.com/ipython/ipython/blob/master/IPython/core/magic.py#L541</a><br><br>That in turn calls shell.inspect.pinfo, which is here:<br>

<a href="https://github.com/ipython/ipython/blob/master/IPython/core/oinspect.py#L435">https://github.com/ipython/ipython/blob/master/IPython/core/oinspect.py#L435</a><br><br>I think probably the best approach would be to make an extension ( <a href="http://ipython.org/ipython-doc/stable/config/extensions/index.html">http://ipython.org/ipython-doc/stable/config/extensions/index.html</a> ), which would subclass Inspector, overriding the pinfo method with one that produced an HTML result to send to the frontend.<br>

<br>Best wishes,<br>Thomas<br><br><div class="gmail_quote">On 25 January 2012 16:56, Maccarthy, Jonathan K <span dir="ltr">&lt;<a href="mailto:jkmacc@lanl.gov">jkmacc@lanl.gov</a>&gt;</span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

Hello,<br>
<br>
Does anyone know if it&#39;s possible to have iPython render reStructuredText (i.e. Sphinx) docstrings when you type &#39;help foo&#39;, or &#39;foo?&#39;  ?  I&#39;m finding that many projects are moving to Sphinx documentation, which makes their docstrings harder to read on the fly (unpythonic?).  &lt;rant&gt; Needing a browser to view the docs seems to miss the point of docstrings. &lt;/rant&gt;  Does iPython have this functionality somewhere?  If not, perhaps any devs could suggest where in the iPython source it would go (if this is even feasible)?<br>


<br>
Thanks in advance,<br>
Jon<br>
_______________________________________________<br>
IPython-User mailing list<br>
<a href="mailto:IPython-User@scipy.org">IPython-User@scipy.org</a><br>
<a href="http://mail.scipy.org/mailman/listinfo/ipython-user" target="_blank">http://mail.scipy.org/mailman/listinfo/ipython-user</a><br>
</blockquote></div><br>