[Numpy-discussion] numpy docstring sphinx pre-processors

David Warde-Farley dwf@cs.toronto....
Mon Sep 21 12:34:54 CDT 2009


On 21-Sep-09, at 1:20 PM, Elaine Angelino wrote:

> thanks robert!
>
> yes i saw this (http://svn.scipy.org/svn/numpy/trunk/doc/sphinxext/)  
> but is there a good description of how to use this?  i'm looking for  
> a "standard recipe" that could be followed by myself and others.   
> e.g. what functions to call and in what order... i would like to  
> emulate what numpy does as closely as possible.

You should have a look at matplotlib's sampledoc tutorial. It goes  
over how to use Sphinx extensions.

http://matplotlib.sourceforge.net/sampledoc/

David


More information about the NumPy-Discussion mailing list