Metadata-Version: 1.0
Name: topp.recipes.opvarnish
Version: 0.1.0dev-r19447
Summary: OpenPlans varnish caching server configuration
Home-page: http://topp.openplans.org/
Author: TOPP
Author-email: info@openplans.org
License: GPLv3
Description: zc.buildout recipe for an OpenPlans site varnish configuration
        
        Change history
        **************
        
        ${0.1.0 or "0.0.0"} (xxxx-xx-xx)
        ==================
        
        - Created recipe with ZopeSkel [${TOPP or ""}].
        
        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 = topp.recipes.opvarnish
        ... option1 = %(foo)s
        ... option2 = %(bar)s
        ... """ % { 'foo' : 'value1', 'bar' : 'value2'})
        
        Running the buildout gives us::
        
        >>> print system(buildout)
        Upgraded:
        ...
        Installing test1.
        Unused options for test1: 'option2' 'option1'.
        
        
        
        Contributors
        ************
        
        ${TOPP or ""}, Author
        
        
        Download
        ********
        
Platform: UNKNOWN
Classifier: Framework :: Buildout
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
