root / pycommunity / pycommunity / doc / tutorial.txt

========
tutorial
========

`tutorial` provides a task to create html recipes out of
reST files.

`TutorialTask` knows how to process a recipe folder, rendering each recipe
it founds::

    >>> from tutorial import TutorialTask
    >>> class Conf(object):
    ...     targets = {'tutorial1': 'tests/www'}
    ...     recipes = {}
    ...     tutorials = {'tutorials': 'tests/svn/project/tutorials'}
    ...     templates = {'tutorial': 'tests/templates/tutorial.pt',
    ...                  'tutoriallist': 'tests/templates/tutoriallist.pt'}
    ...     glossary = 'tests/svn/project/doc/glossary.txt'
    ...
    >>> task = TutorialTask()
    >>> task._run(Conf())

Let's see the result, and check if it links to recipe1::

    >>> res = open('tests/www/tutorials/how_to_use.html').read()
    >>> "<a title='glossary_recipe' alt='glossary_recipe'" in res
    True
    >>> "<a title='main_readme_recipe' alt='main_readme_recipe'" in res
    True