Metadata-Version: 1.0
Name: z3c.recipe.epydoc
Version: 0.0.2
Summary: Use EpyDoc to build documentation for python modules
Home-page: http://pypi.python.org/pypi/z3c.recipe.epydoc/
Author: Andrew Mleczko
Author-email: andrew@mleczko.net
License: ZPL 2.1
Description: z3c.recipe.epydoc
        ====================
        
        Introduction
        ------------
        
        This buildout recipe generates epydoc documentation for you project
        
        Usage Instructions
        ------------------
        
        Let's say you have a package called ezineserver. In the buildout.cfg file of your package, add a ``docs`` section
        that looks like this::
        
        [docs]
        recipe = z3c.recipe.epydoc
        eggs =
        z3c.recipe.epydoc
        ezineserver
        doc = ezineserver
        
        Be sure to include it in the parts, as in::
        
        [buildout]
        develop = .
        parts = docs
        
        Now you can rerun buildout.  The recipe will have created an
        executable script in the bin directory called ``docs``.
        
        This script will run the epydoc documentation generation tool on your
        source code.
        
        To generate documentation simply run ``docs`` script::
        
        $ ./bin/docs --no-frames
        
        Notice that since version 0.0.2 you can pass additional epydoc options.
        This generates all the documentation for you and placed it in the
        parts directory.  You can then open it up in firefox and take a look::
        
        $ firefox parts/docs/index.html
        
        And that's it!
        
        =======
        CHANGES
        =======
        
        
        0.0.2 (2008-07-09)
        ------------------
        - Pass sys.argv to bin/docs (you can pass additional epydoc options do script)
        
        
        0.0.1 (2008-07-08)
        ------------------
        
        - Initial release.
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Zope2
Classifier: Framework :: Zope3
Classifier: Framework :: Plone
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
