[Numpy-discussion] Easy way to test documentation?

Pauli Virtanen pav@iki...
Mon Oct 5 15:10:07 CDT 2009


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
...
$ vi conf.py
... add 'sphinx.ext.autodoc', 'numpydoc' to extensions ...
$ cp /some/path/modulename.py modulename.py
$ vi index.rst
...
  add 
  .. automodule:: modulename
     :members:
...
$ make PYTHONPATH=$PWD html

Could be automated.

-- 
Pauli Virtanen



More information about the NumPy-Discussion mailing list