Hi Carlos,<div><br></div><div>Thanks for jumping in. In fact, updating my Sphinx installation to 1.1.3 and checking out spyder from hg base, I can see the docstrings for np.random.lognormal is rendered just like I was asking for. This layout is quite good for my documentation need. I also found the documentation source for lognormal at <a href="http://docs.scipy.org/numpy/source/numpy/numpy/random/mtrand/mtrand.pyx#3026">http://docs.scipy.org/numpy/source/numpy/numpy/random/mtrand/mtrand.pyx#3026</a></div>
<div><br></div><div>I will start from there and work on creating my long-overdue cloud physics function library documentation project :) This will hopefully attract others out there who prefers IDL over Python for their atmospheric science related coding.<br>
<br><div class="gmail_quote">On Thu, Jan 24, 2013 at 5:30 AM, Carlos Córdoba <span dir="ltr">&lt;<a href="mailto:ccordoba12@gmail.com" target="_blank">ccordoba12@gmail.com</a>&gt;</span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

  
    
  
  <div bgcolor="#FFFFFF" text="#000000">
    Gökhan, we already have exactly what you&#39;re asking for in Spyder.
    Docstrings are displayed in rich text mode under our plugin called
    &quot;Object Inspector&quot;. This works for objects introspected from the
    Editor or the IPython console, using Ctrl+I. In version 2.2 (in
    beta) we&#39;ve also added math rendering, using the Sphinx mathJax
    plugin.<br>
    <br>
    As Matthias said, the plugin can&#39;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&#39;s not that hard because almost all docstrings from the standard
    library are not in rst, it&#39;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>El 23/01/13 22:03, Gökhan Sever
      escribió:<br>
    </div>
    <blockquote type="cite"><div><div class="h5">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" target="_blank">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="line-height:20px;text-align:justify;font-size:16px;font-family:sans-serif">&quot;The
          probability density function for the log-normal distribution
          is&quot;</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></fieldset>
      <br>
      </div></div><div class="im"><pre>_______________________________________________
IPython-User mailing list
<a href="mailto:IPython-User@scipy.org" target="_blank">IPython-User@scipy.org</a>
<a href="http://mail.scipy.org/mailman/listinfo/ipython-user" target="_blank">http://mail.scipy.org/mailman/listinfo/ipython-user</a>
</pre>
    </div></blockquote>
    <br>
  </div>

<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>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br>Gökhan
</div>