<html>
  <head>
    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
  </head>
  <body bgcolor="#FFFFFF" text="#000000">
    Gökhan, we already have exactly what you're asking for in Spyder.
    Docstrings are displayed in rich text mode under our plugin called
    "Object Inspector". This works for objects introspected from the
    Editor or the IPython console, using Ctrl+I. In version 2.2 (in
    beta) we've also added math rendering, using the Sphinx mathJax
    plugin.<br>
    <br>
    As Matthias said, the plugin can't render all docstrings correctly
    (because not all are in rst) but: a) you can also view them in plain
    text and b) we plan to improve that during the next months. I think
    it's not that hard because almost all docstrings from the standard
    library are not in rst, it's not so complicated to detect if a
    dosctring is in numpydoc (using the tools provided by numpydoc) and
    for all the rest we could highlight only code snippets, if present.<br>
    <br>
    Cheers,<br>
    Carlos<br>
    <br>
    <div class="moz-cite-prefix">El 23/01/13 22:03, Gökhan Sever
      escribió:<br>
    </div>
    <blockquote
cite="mid:CAE5kuyhQfnHSO9yH109zDaRpG1Arhf59wQj-EP1G=wJ=9xRkvw@mail.gmail.com"
      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 moz-do-not-send="true"
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>
      <fieldset class="mimeAttachmentHeader"></fieldset>
      <br>
      <pre wrap="">_______________________________________________
IPython-User mailing list
<a class="moz-txt-link-abbreviated" href="mailto:IPython-User@scipy.org">IPython-User@scipy.org</a>
<a class="moz-txt-link-freetext" href="http://mail.scipy.org/mailman/listinfo/ipython-user">http://mail.scipy.org/mailman/listinfo/ipython-user</a>
</pre>
    </blockquote>
    <br>
  </body>
</html>