root / pycommunity / pycommunity / doc / recipe.txt

======
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::

    >>> from recipe import RecipeTask
    >>> class Conf(object):
    ...     targets = {'target1': 'tests/www'}
    ...     tutorials = {'recipes': 'tests/svn/project/tutorials'}    
    ...     recipes = {'recipes': 'tests/svn/project/recipes'}   
    ...     templates = {'recipe': 'tests/templates/recipe.pt',
    ...                  'recipelist': 'tests/templates/recipelist.pt'}
    ...     glossary = 'tests/svn/project/doc/glossary.txt'
    ...
    >>> task = RecipeTask()
    >>> task._run(Conf())