<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; ">Hi Gökhan,&nbsp;<div><br></div><div>There are no define plan, but the issue has already been raised.&nbsp;</div><div>I even had a draft branch that was doing something like that (<a href="https://github.com/Carreau/ipython/tree/_doc_star">https://github.com/Carreau/ipython/tree/_doc_star</a>)</div><div>with nice HTML and equation rendering.</div><div><br></div><div>Still I think it have to be well thought to be correctly done. The issue I encounterd while writing this draft branch</div><div>were that you have several kind of syntax for docstrig (rst, numpy, …) so you probably need to decorate them</div><div>to declare their 'type'. (possibly using annotations &nbsp;on python 3)</div><div><br></div><div>The other is that it is nice to have pretty docstring written in html or else, but then they are unreadable in plaintext.</div><div><br></div><div>So IMHO, the correct way to do that would be to 'declare' the format either at module level and/or with decorators,&nbsp;</div><div>so that you can process the docstoring , either to convert it to plaintext, or html…. etc.&nbsp;</div><div>Kind of replicating the _repr_*_ of object in IPython but with docstrings.</div><div><br></div><div>The second problem is often that generated doc with sphinx are parsed on the whole module at once, allowing custom</div><div>cross-link between classes/project. Which is not doable when you parse docstring live. Also docstring that have graphs and</div><div>everything can take a huge time to generate, and the generation can possibly fail. ( if you don't have matplotlib fofr example)</div><div><br></div><div>So one possible way would be to add a link to locally builded/downloaded documentation, or a magic that would build the doc for a specific module.</div><div>We could also provide a link to the page of official documentation, but probably not embed it for security reason.</div><div><br></div><div>In any way, if you wish to work on that, we can give you pointers. But I think the first thing to do would be to lay down</div><div>the requirement and the possible way to do do it. It will also probably need a spec change on object_info_request and a bump in&nbsp;</div><div>protocol version.</div><div><br></div><div>Thanks,&nbsp;</div><div>--&nbsp;</div><div>Matthias</div><div><br></div><div><br></div><div><br></div><div><br></div><div><br></div><div><div><div>Le 24 janv. 2013 à 04:03, Gökhan Sever a écrit :</div><br class="Apple-interchange-newline"><blockquote type="cite">Hello,<div><br></div><div>Is there any plan for IPython notebook to support pretty rendering of docstrings?</div><div><br></div><div>Take for instance:</div><div><br></div><div><a href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.random.lognormal.html">http://docs.scipy.org/doc/numpy/reference/generated/numpy.random.lognormal.html</a></div>
<div><br></div><div>Sphinx puts a nice rendered equation (probably via MathJax), right below:</div><div><br></div><div><span style="font-family:sans-serif;font-size:16px;line-height:20px;text-align:justify;background-color:rgb(255,255,255)">"The probability density function for the log-normal distribution is"</span></div>
<div><br></div><div>and the layout of documentation is quite neat.</div><div><br></div><div>Sage notebook also renders the equation fine. Can this be supported in IPython notebook?</div><div><br></div><div>I am particularly interested in equation rendering, since I am planning to insert latex representation of the equations in function docstrings.</div>
<div><br></div><div>Thanks.<br clear="all"><div><br></div>-- <br>Gökhan
</div>
_______________________________________________<br>IPython-User mailing list<br><a href="mailto:IPython-User@scipy.org">IPython-User@scipy.org</a><br>http://mail.scipy.org/mailman/listinfo/ipython-user<br></blockquote></div><br></div></body></html>