[SciPy-dev] how scipy reference guide is generated

josef.pktd@gmai... josef.pktd@gmai...
Wed Dec 23 06:11:55 CST 2009


On Wed, Dec 23, 2009 at 3:35 AM, Scott Sinclair
<scott.sinclair.za@gmail.com> wrote:
>>2009/12/23 Forrest Sheng Bao <forrest.bao@gmail.com>:
>> I want to know which toolchain is used to generate a doc like scipy
>> reference guide.
>
> The reference guide is generated from ReStructured Text (ReST) files
> using Sphinx (http://sphinx.pocoo.org/).
>
> You can take a look at http://docs.scipy.org/numpy/Front%20Page/ for
> some more information on how this is achieved. It might also be worth
> poking around in http://projects.scipy.org/numpy/browser/trunk/doc.
>
> You can probably get away with a far less complex setup to generate
> your own docs from Sphinx.

There was a thread on the numpy mailing list on Sept 21: "numpy
docstring sphinx pre-processors"
that explained a bit the use of numpydoc for other projects.

BTW: I like the new style sheet of the scipy docs. I haven't looked at
it in a while.

Josef


>
> Cheers,
> Scott
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev@scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>


More information about the SciPy-Dev mailing list