Epydoc Website | Download | Epytext Markup
Epydoc is a API documentation generator for python. On their website they give instruction on how to install it. In my case I run the installation the python way: download the compressed sources, cd into it, and run:
python setup.py install
My typical use is from the command line like this:
python epydoc.py --html gx -o docs -v
Where epydoc.py is the following file:
import sys, os.path script_path = os.path.abspath(sys.path[0]) sys.path = [p for p in sys.path if os.path.abspath(p) != script_path] sys.path.append( '/Users/noema/Development/svn/gx' ) from epydoc.cli import cli cli()
NOTE: In my case I use mayapy instead of python because I need Epydoc for the interpreter that comes with Maya 8.5. But for some reason it works for the standard interpreter as well.