[Numpy-discussion] Easy way to test documentation?

Charles R Harris charlesr.harris@gmail....
Mon Oct 5 20:27:40 CDT 2009


On Mon, Oct 5, 2009 at 6:57 PM, Charles R Harris
<charlesr.harris@gmail.com>wrote:

>
>
> On Mon, Oct 5, 2009 at 2:10 PM, Pauli Virtanen <pav@iki.fi> wrote:
>
>> ma, 2009-10-05 kello 13:54 -0600, Charles R Harris kirjoitti:
>> > Is there an easy way to test build documentation for a module that is
>> > not yet part of numpy?
>>
>> Make a small Sphinx project for that:
>>
>> $ easy_install numpydoc
>> $ mkdir foo
>> $ cd foo
>> $ sphinx-quickstart
>>
>
> What to choose for math rendering? Defaults for everything else?
>
>
>> ...
>> $ vi conf.py
>> ... add 'sphinx.ext.autodoc', 'numpydoc' to extensions ...
>> $ cp /some/path/modulename.py modulename.py
>> $ vi index.rst
>>
>
> index.py, right?
>
>

OK, had to choose file type (txt/rst)


> ...
>>  add
>>
>
append


>  .. automodule:: modulename
>>     :members:
>> ...
>> $ make PYTHONPATH=$PWD html
>>
>>
>
Seems to work.

Chuck
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/numpy-discussion/attachments/20091005/8ef8d9a1/attachment.html 


More information about the NumPy-Discussion mailing list