Permalink
Browse files

DOC: document the build_sphinx command

  • Loading branch information...
1 parent f19c889 commit 986f51da210a79aa0912d8e4ce0f882244780f8e @pv pv committed Feb 9, 2013
Showing with 25 additions and 7 deletions.
  1. +10 −1 INSTALL.txt
  2. +15 −6 doc/README.txt
View
@@ -36,6 +36,10 @@ __ http://www.python.org
__ http://www.numpy.org/
+3) If you want to build the documentation: Sphinx__ 1.1.0 or newer
+
+__ http://http://sphinx-doc.org/
+
Windows
-------
@@ -133,7 +137,12 @@ $HOME/lib/python2.4/site-packages/scipy). Then type::
git clean -xdf
python setup.py install
-
+Documentation
+-------------
+Type::
+
+ cd scipy
+ python setup.py build_sphinx
INSTALLATION
============
View
@@ -1,12 +1,21 @@
-SciPy Reference Guide
-=====================
+SciPy Documentation
+===================
-Instructions
-------------
+How to build it
+---------------
+The easy way to build the documentation is to run
+
+ python setup.py build_sphinx
+
+This will make first build Scipy in-place, and then generate documentation for
+it.
+
+Another way
+-----------
1. Optionally download an XML dump of the newest docstrings from the doc wiki
at ``/pydocweb/dump`` and save it as ``dump.xml``.
2. Run ``make html`` or ``make dist``
-You can also run ``summarize.py`` to see which parts of the Numpy
-namespace are documented.
+Note that ``make html`` builds the documentation for the currently installed
+version of Scipy, not the one corresponding to the source code here.

0 comments on commit 986f51d

Please sign in to comment.