This page describes the distribution structure and HTML documentation templates for Python packages developed by ITR after March 2004. This page is written by Johnny Lin and is last updated March 24, 2004.
Packages distributions have the following directory structure:
/package_directory /doc /imgs /style /src /lib /test README.txt setup.py
All names of files and directories are as given above, except
package_directory which is the name of the package
distribution directory given by the author. Generally, it is
made of the package name followed by a hyphen and the version
number. For instance, atmqty-0.3.0.1 contains version 0.3.0.1
Compiled source goes in /src, Python code in /lib, documentation (including pydoc HTML documentation) in /doc (imgs and style are for images and CSS files respectively), and test scripts in /test. Thus, install occurs by:
via thepython setup.py install
All HTML documentation (not created by pydoc) for the packages should be based upon the template.html and librootcsc.css HTML and CSS files below. This includes bug reports, examples, manuals, and other references.
stylein the package distribution tree. Last updated 29 Mar 2004.
<address>) and how they are nested in relation to the class blocks. Last updated 24 Mar 2004.
A few notes about the templates:
modlistand delineated in a
div) only controls coloring by CSS...the HTML file controls the
cellpadding, etc. values.
centerto replace the
<center>tag for both text and tables. You use it within
<center>is deprecated in HTML 4.01.