[SciPy-dev] Generating SciPy Sphinx HTML

Pauli Virtanen pav@iki...
Sun Nov 2 15:56:03 CST 2008


Sun, 02 Nov 2008 13:46:32 -0800, Damian Eads wrote:
> I'm at the Berkeley sprint now trying to fix a few doc bugs. Can anyone
> point me to instructions or a script for generating Sphinx HTML
> documentation from the RST docstrings?

Like this, for Scipy:

	svn co http://svn.scipy.org/svn/scipy/scipy-docs/trunk scipy-docs
	cd scipy-docs
	export PYTHONPATH=/wherever/your/scipy/is
	make html

and for Numpy,

	svn co http://svn.scipy.org/svn/numpy/numpy-docs/trunk numpy-docs
	cd numpy-docs
	export PYTHONPATH=/wherever/your/numpy/is
	make html

Note that you need Sphinx 0.5.dev development version, and to actually 
compile Numpy or Scipy first.

Sphinx 0.5:

	svn co http://svn.python.org/projects/doctools/trunk sphinx-trunk
	cd sphinx-trunk
	python setup.py install

Pauli Virtanen

More information about the Scipy-dev mailing list