[SciPy-dev] Generating SciPy Sphinx HTML

Nils Wagner nwagner@iam.uni-stuttgart...
Tue Nov 4 09:03:13 CST 2008


On Sun, 2 Nov 2008 21:56:03 +0000 (UTC)
  Pauli Virtanen <pav@iki.fi> wrote:
> Hi,
> 
> 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
> 
> _______________________________________________
> Scipy-dev mailing list
> Scipy-dev@scipy.org
> http://projects.scipy.org/mailman/listinfo/scipy-dev
  
I struggled to build the documentation

svn/scipy-docs > make html
svn co 
http://sphinx.googlecode.com/svn/contrib/trunk/numpyext 
ext
A    ext/LICENSE.txt
A    ext/tests
A    ext/tests/test_docscrape.py
A    ext/docscrape_sphinx.py
A    ext/traitsdoc.py
A    ext/numpydoc.py
A    ext/__init__.py
A    ext/autosummary_generate.py
A    ext/phantom_import.py
A    ext/comment_eater.py
A    ext/docscrape.py
A    ext/autosummary.py
A    ext/compiler_unparse.py
Checked out revision 22.
mkdir -p build
./ext/autosummary_generate.py source/*.rst \
         -p dump.xml -o source/generated
Traceback (most recent call last):
   File "./ext/autosummary_generate.py", line 18, in ?
     from autosummary import import_by_name
   File 
"/data/home/nwagner/svn/scipy-docs/ext/autosummary.py", 
line 59, in ?
     import sphinx.addnodes, sphinx.roles, sphinx.builder
   File 
"/data/home/nwagner/local/lib/python2.5/site-packages/Sphinx-0.5dev_20081104-py2.5.egg/sphinx/__init__.py", 
line 68
     '-c' not in (opt[0] for opt in opts):
                           ^
SyntaxError: invalid syntax
make: *** [build/generate-stamp] Error 1

Any pointer ?

Nils


More information about the Scipy-dev mailing list