[Pythonmac-SIG] Documentation Project

[Chris Barker]

Vincent Marchetti wrote:
> I've recently been working with the OSA support, using Python to control
> applications I'm writing
> through Apple Events. I can take on documenting the modules used here
> including aetools, aepack, AE,
> etc, and organizing the How-To and examples in the scripting folder.

Great! Consider your offer accepted.

 
> I can work with LaTex, -- in one of your earlier messages you (Chris)
> mention a document on
> documentation -- where is this?.

Cool. The "doc" doc is part of the official Python docs series (along
with the tutorial, the Library reference, and the mac doc that I'm
working on). It can be found at:

http://www.python.org/doc/current/doc/doc.html

or the PS and PDF versions can be downloaded from:

http://www.python.org/doc/current/download.html


> Is there a LaTex template (style file?)
> for producing the standard module documentation?

There certainly is, and it is pretty rigid to allow the various versions
of the docs to be generated, and all be cross-referenced and indexed
correctly. Take a look at the doc doc, and then download the docs from
the sourceforge CVS server for samples. (If that's a pain, I can send
them to you.)
 
-Chris


-- 
Christopher Barker,
Ph.D.                                                           
cbarker@jps.net                      ---           ---           ---
http://www.jps.net/cbarker          -----@@       -----@@       -----@@
                                   ------@@@     ------@@@     ------@@@
Water Resources Engineering       ------   @    ------   @   ------   @
Coastal and Fluvial Hydrodynamics -------      ---------     --------    
------------------------------------------------------------------------
------------------------------------------------------------------------