root / PyCon07 / material / pycommunity_undocumented / modules.txt

===========
PyCommunity
===========

package
=======

package provides a `PackageTask` class that is used to generate documentation 
for packages. It scans each package folder and uses several page templates
to generate html pages:

- `packageindex`: a template for the index page

- `packagedoc`: a template for each reST file founded in the folder

- `packagestats`: a page that gathers stats about the package

generator
=========

generator provides a class that execute a serie of tasks to generate the 
website, given a configuration. A task is a virtual class that provide a 
transformation for a given type of file. It is registered at runtime and its 
id correspond to the section it covers.

The generator is programmed with a sequence of keys, that will call the task 
in order, with arguments.

resttask
========

Provides base class for tasks that deals with rest files.

`TaksView` provides a generic viewer, that knows how to render rest files,
given a Cheetah template and a reST file::

The content is also scanned, to replace glossary entries.

index
=====

index provides two classes:

- `IndexView` is a class that generates the index, using a cheetah template.
- `IndexTask` is a class task that can be used in the generator.

recipe
======

`recipe` provides a task to create html recipes out of reST files. 
`RecipeTask` knows how to process a recipe folder, rendering each recipe 
it founds.