-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathREADME
More file actions
20 lines (12 loc) · 647 Bytes
/
Copy pathREADME
File metadata and controls
20 lines (12 loc) · 647 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Sphinx Documentation
--------------------
Note: Sphinx actually runs and imports python code, so broken code, or code not in conf.py sys.path, cannot be documented!
1. Get Sphinx [http://sphinx.pocoo.org/]
[python setup.py build/install]
2. Install numpydoc [http://pypi.python.org/pypi/numpydoc]
3. In Makefile point to your own copy of sphinx-build, e.g.
[SPHINXBUILD = /Users/steve/CODES/Sphinx-1.0.6/sphinx-build.py]
4. >> touch *.rst
>> make html [or make latex]
Creating/updating manual on sourceforge:
5. >> rsync -rav _build/html/ user@shell.sourceforge.net:/home/project-web/python-control/htdocs/manual-N.mx/