[SciPy-Dev] Cross-link scipy docs and source code?

Ralf Gommers ralf.gommers@googlemail....
Tue Mar 13 13:26:02 CDT 2012


On Sun, Mar 11, 2012 at 2:42 PM, Pauli Virtanen <pav@iki.fi> wrote:

> 11.03.2012 14:25, Ralf Gommers kirjoitti:
> [clip]
> > Instead of doubling the size of the built docs, why not add a link to
> > the source file on Github?
>
> Yep. Scipy has ~ 5 MB of Python code, and adding HTML formatting on top
> of that would blow up the size by some factor.
>
> Sphinx doesn't seem to have a pre-built extension for this, but it seems
> pretty easy to just write one up and submit it to them. We can keep it
> in Numpy's sphinxext for the time being.
>

Apparently "pretty easy" means "I'll fix it right this minute". It's live
already:
http://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html

Thanks Pauli!

Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20120313/02f439f2/attachment.html 


More information about the SciPy-Dev mailing list