Skip to main content

Use EpyDoc to build documentation for python modules

Project description

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

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:

    $ ./bin/docs --no-frames --include-log
  • or you can use the defaults entry to the docs section:

    [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 - thanks to 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

z3c.recipe.epydoc-0.0.3.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

z3c.recipe.epydoc-0.0.3-py2.4.egg (6.8 kB view details)

Uploaded Source

File details

Details for the file z3c.recipe.epydoc-0.0.3.tar.gz.

File metadata

File hashes

Hashes for z3c.recipe.epydoc-0.0.3.tar.gz
Algorithm Hash digest
SHA256 36a4fa948370f010f8ee6ff35efe14990c7e312e51e3491eacfa38a2ce090cce
MD5 2be321de66110e48b720d70c206bf95f
BLAKE2b-256 b526b017409d794785806f0e8abeb1ff48ba704fe86b2ae3026b8a063f97be8b

See more details on using hashes here.

File details

Details for the file z3c.recipe.epydoc-0.0.3-py2.4.egg.

File metadata

File hashes

Hashes for z3c.recipe.epydoc-0.0.3-py2.4.egg
Algorithm Hash digest
SHA256 1866cf52c52e647edb866e7b216760493932f38ec16799819ba603d63d43290b
MD5 0187876c3cc801a7b2e169beab53ab34
BLAKE2b-256 0609e953930b526e6141628abf7a05721b6d95f4cbbcc1983ba8ad98aa1a4645

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page