File: README.txt

package info (click to toggle)
python-setupdocs 1.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 120 kB
  • ctags: 41
  • sloc: python: 361; makefile: 7; sh: 5
file content (19 lines) | stat: -rw-r--r-- 909 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Setupdocs is a setuptools extension that help doc building automation. It adds two commands to the 
setup.py command.

build_docs
----------
Finds Sphinx source in docs/ and buils html. Can also build latex and pdf with --formats= directive if
latex is installed.

dist_docs
---------
Builds html docs and creates an html.zip in the dist/ folder. With -c, replaces the html.zip in the docs 
folder and checks it in. With -u, it doesn't create the html.zip but instead updates the docs on the 
website. It does this by 1) getting a fresh svn checkout of the docs, 2) building the docs with Sphinx 
and overwriting the old ones, 3) svn adding and checking in the new and changed docs, 4) ssh login to www,
5) cd to the doc dir, 6) svn up and chmod g+w. It's not perfect, but it pretty much works.

Some options can be configured in setup.py, and are in Mayavi and Chaco.

Command-line help is available via -h.