-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: document the build_sphinx command
- Loading branch information
Showing
2 changed files
with
25 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|