Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

Download
ActivePython
INSTALL>
pypm install z3c.recipe.epydoc

How to install z3c.recipe.epydoc

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install z3c.recipe.epydoc
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
0.0.3 Available View build log
Windows (64-bit)
0.0.3 Available View build log
Mac OS X (10.5+)
0.0.3 Available View build log
Linux (32-bit)
0.0.3 Available View build log
Linux (64-bit)
0.0.3 Available View build log
 
License
ZPL 2.1
Lastest release
version 0.0.3 on Jan 5th, 2011

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]

System Message: ERROR/3 (<string>, line 16)

Inconsistent literal block quoting.

recipe = z3c.recipe.epydoc eggs = z3c.recipe.epydoc ezineserver doc = ezineserver

Be sure to include it in the parts, as in:

[buildout]

System Message: ERROR/3 (<string>, line 25)

Inconsistent literal block quoting.

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

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!

Specify additional options

It's also possible to pass additional epydoc options to the docs script (for a list of all available options, run the script with the --help option).

You can do this from two different ways:

  • you can pass options directly to the script:

    System Message: WARNING/2 (<string>, line 56)

    Literal block expected; none found.

$ ./bin/docs --no-frames --include-log

  • or you can use the defaults entry to the docs section:

    System Message: WARNING/2 (<string>, line 60)

    Literal block expected; none found.

[docs] recipe = z3c.recipe.epydoc eggs = z3c.recipe.epydoc ezineserver doc = ezineserver defaults = ['no-frames', '--include-log']

This allows you to create a script with the same options as if you had specified them on the command line.

If not set, the defaults entry will default to the value ['-v', '--debug'].

CHANGES

0.0.3 (2009-03-10)

  • Add default cli arguments option in buildout.cfg

System Message: WARNING/2 (<string>, line 82)

Bullet list ends without a blank line; unexpected unindent.

[Jonathan Ballet]

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.

Subscribe to package updates

Last updated Jan 5th, 2011

Download Stats

Last month:1

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.