my.demo.recipe 1.0dev

.. contents::

.. Note to recipe author!
---------------------
Update the following URLs to point to your:

- code repository
- bug tracker
- questions/comments feedback mail
(do not set a real mail, to avoid spams)

Or remove it if not used.

- Code repository: http://svn.somewhere.com/...
- Questions and comments to somemailing_list
- Report bugs at http://bug.somewhere.com/..


Detailed Documentation
**********************

Supported options
=================

The recipe supports the following options:

.. Note to recipe author!
----------------------
For each option the recipe uses you shoud include a description
about the purpose of the option, the format and semantics of the
values it accepts, whether it is mandatory or optional and what the
default value is if it is omitted.

option1
Description for ``option1``...

option2
Description for ``option2``...


Example usage
=============

.. Note to recipe author!
----------------------
zc.buildout provides a nice testing environment which makes it
relatively easy to write doctests that both demonstrate the use of
the recipe and test it.
You can find examples of recipe doctests from the PyPI, e.g.

http://pypi.python.org/pypi/zc.recipe.egg

The PyPI page for zc.buildout contains documentation about the test
environment.

http://pypi.python.org/pypi/zc.buildout#testing-support

Below is a skeleton doctest that you can start with when building
your own tests.

We'll start by creating a buildout that uses the recipe::

>>> write('buildout.cfg',
... """
... [buildout]
... parts = test1
...
... [test1]
... recipe = my.demo.recipe
... option1 = %(foo)s
... option2 = %(bar)s
... """ % { 'foo' : 'value1', 'bar' : 'value2'})

Running the buildout gives us::

>>> print 'start', system(buildout) # doctest:+ELLIPSIS
start...
Installing test1.
Unused options for test1: 'option2' 'option1'.
<BLANKLINE>



Contributors
************

${Tarek or ""}, Author


Change history
**************

${1.0 or "0.0.0"} (xxxx-xx-xx)
==================

- Created recipe with ZopeSkel [${Tarek or ""}].

Download
********