Use EpyDoc to build documentation for python modules
This buildout recipe generates epydoc documentation for you project
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:
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'].
- Add default cli arguments option in buildout.cfg - thanks to Jonathan Ballet
- Pass sys.argv to bin/docs (you can pass additional epydoc options do script)
- Initial release.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size z3c.recipe.epydoc-0.0.3-py2.4.egg (6.8 kB)||File type Egg||Python version 2.4||Upload date||Hashes View hashes|
|Filename, size z3c.recipe.epydoc-0.0.3.tar.gz (4.4 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for z3c.recipe.epydoc-0.0.3-py2.4.egg