| Version 1 (modified by travis, 6 years ago) |
|---|
How to Autogenerate API Docs for SciPy/NumPy?
The current approach to generating docs uses the Open Source endo application developed by Enthought. There has been much discussion about improving the process/docstrings and using epydoc. Until this happens, the following method works for endo:
In a directory that contains the following files:
scipyheader.txt scipylogo.png default.css
One may run the following command (if endo.py is in the dir or in your path, of course):
python endo.py -r SciPy=~/site-packages/scipy-0.6.0-py2.5-macosx-10.3-fat.egg/scipy/ --rst -d /Users/travis/Documents/scipyapidocs/ --data=scipylogo.png --header-file=scipyheader.txt --css=default.css
This runs the doc generation tool over a scipy instance installed on my Mac OSX machine and places the generated files in the directory /Users/travis/Documents/scipyapidocs/
These files may then be uploaded to the scipy server at this location:
/home/scipy/public_html/doc/api_docs
Attachments
- scipylogo.png (6.8 KB) - added by travis 6 years ago.
- scipyheader.txt (320 bytes) - added by travis 6 years ago.
- default.css (2.4 KB) - added by travis 6 years ago.
