lemon.external.epydoc

Package lemon :: Package external :: Package epydoc

[show private | hide private]

Package lemon.external.epydoc

Automatic Python reference documentation generator. Epydoc processes Python modules and docstrings to generate formatted API documentation, in the form of HTML pages. Epydoc can be used via a command-line interface (epydoc.cli) and a graphical interface (epydoc.gui). Both interfaces let the user specify a set of modules to document, and produce API documentation using the following steps:

Import the requested modules, using epydoc.imports.
Construct documentation for each object, using epydoc.objdoc.
- epydoc.uid is used to create unique identifiers for each object.
- The epydoc.markup package is used to parse the objects' documentation strings.
Generate output, using epydoc.html or epydoc.latex.
- epydoc.css is used to generate the CSS stylehseet for HTML output.
- epydoc.help is used to generate the help page for HTML output.
- epydoc.colorize is used to colorize doctest blocks and regular expressions variable values for HTML output.

Version: 2.0

Author: Edward Loper

License: IBM Open Source License

Requires: Python 2.1+, or Python 2.0 with inspect.py.

See Also:: The epydoc webpage, The epytext markup language manual

To Do for Version 3.0:

Refactor epydoc.objdoc.ObjDoc:
- ObjDocs will contain info about objects, but not gather it.
- An inspection module will gather info via inspection.
- A new parsing module will provide an alternative, gathering info by parsing python files.
- Var will be replaced by VarDoc, a subclass of ObjDoc.
- Structure ObjDocs in a directed acyclic graph, rather than using a links and a dictionary? Are non-directed cycles a problem? Interaction of the access hierarchy (a.b.c) and the base class hierarchy? What does pydoc do?
Create a better default top_page than trees.html.
Add the man-page style outputter. (epyman)
Docstring inheritance for overridden properties.
Optimize epytext
- Use classes instead of minidom nodes?
Rewrite epydoc.uid.findUID to be more robust.

Contributors (Alphabetical Order):

Submodules
Interface Modules
`cli`: Command-line interface for epydoc. `gui`: Graphical interface to epydoc.
Inspection Modules
`uid`: Unique identifiers and crossreference links for Python objects. `objdoc`: Support for `ObjDoc`s, which encode the information about a Python object that is necessary to create its documentation. `imports`: Module import support for epydoc.
Docstring Parsing Modules
`markup`: Markup language support for docstrings. `epytext`: Parser for epytext strings. `javadoc`: Epydoc parser for Javadoc docstrings. `plaintext`: Parser for plaintext docstrings. `restructuredtext`: Epydoc parser for ReStructuredText strings.
Documentation Output Modules
`html`: Documentation to HTML converter. `css`: Predefined CSS stylesheets for the HTML outputter (`epydoc.html`). `help`: Default help file for the HTML outputter (`epydoc.html`). `colorize`: Functions to produce colorized HTML code for various objects. `latex`: Documentation to LaTeX converter. `man`: Documentation formatter that produces man-style documentation.
Testing Modules
`checker`: Documentation completeness checker. `test`: Unit tests for the NLTK modules. `epytext`: Regression testing for the epytext markup language.

Variable Summary
`str`	`__author__` = `'Edward Loper <edloper@gradient.cis.upenn.e...`
`str`	`__license__`: The license governing the use and distribution of epydoc.
`str`	`__url__` = `'http://epydoc.sourceforge.net'`
`str`	`__version__` = `'2.0'`

Variable Details

author

Type:: str
Value:: 'Edward Loper <edloper@gradient.cis.upenn.edu>'

license

The license governing the use and distribution of epydoc.

Type:: str
Value:: 'IBM Open Source License'

url

Type:: str
Value:: 'http://epydoc.sourceforge.net'

version

Type:: str
Value:: '2.0'

Generated by Epydoc 2.0 on Mon Nov 10 15:08:12 2003

http://epydoc.sf.net

Package lemon.external.epydoc

__author__

__license__

__url__

__version__

author

license

url

version