<br><br><div class="gmail_quote">On Sun, Mar 11, 2012 at 2:05 PM,  <span dir="ltr">&lt;<a href="mailto:josef.pktd@gmail.com">josef.pktd@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 class="HOEnZb"><div class="h5">On Sun, Mar 11, 2012 at 7:51 AM, Christoph Deil<br>
&lt;<a href="mailto:deil.christoph@googlemail.com">deil.christoph@googlemail.com</a>&gt; wrote:<br>
&gt; Hi,<br>
&gt;<br>
&gt; would it be possible to cross-link the scipy docs and source code?<br>
&gt;<br>
&gt; I would find that very useful and I could imagine that this might in the<br>
&gt; long run lead to more scipy contributors (see recent mailing list thread<br>
&gt; that there are too few of those).<br>
&gt; More users will start to browse the code and understand how things are<br>
&gt; implemented and eventually feel competent enough to add the features they<br>
&gt; need in scipy instead of writing their own modules / wrappers based on<br>
&gt; scipy.<br>
&gt;<br>
&gt; Here&#39;s an example that shows how scipy docs currently look (no link to<br>
&gt; source code):<br>
&gt; <a href="http://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html" target="_blank">http://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html</a><br>
&gt;<br>
&gt; statsmodels is an example of a  package that has cross-linked their auto<br>
&gt; docs and source code:<br>
&gt; <a href="http://statsmodels.sourceforge.net/generated/scikits.statsmodels.robust.robust_linear_model.RLM.html" target="_blank">http://statsmodels.sourceforge.net/generated/scikits.statsmodels.robust.robust_linear_model.RLM.html</a><br>

<br>
</div></div>IIRC, we added the source in statsmodels by accident, however I don&#39;t<br>
find any discussion anymore.<br>
It&#39;s a bit similar to the (old style) DOXYGEN generated documentation.<br>
I don&#39;t think sphinx would handle parts of scipy that are not in<br>
python.<br>
<br>
I like having quick access to the source to see what a function<br>
actually does. For scipy, I rely most of the time on the object<br>
inspector in Spyder that is able to pull up the docstring and the<br>
source, or sometimes on numpy.source<br>
<br>
The only thing I would worry a bit with adding the source is the size<br>
of the htmlhelp, but I don&#39;t think it will get too large or sluggish.<br></blockquote><div><br>Instead of doubling the size of the built docs, why not add a link to the source file on Github?<br></div></div><br>Ralf<br>
<br>