Package 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.1
Author: Edward
Loper
Copyright: (C) 2003 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: Consider other names for @undocumented
:
@bypass
, @nodoc
,
@exclude
, @omit
?
To Do for Version 3.0:
- Support encodings.
- Refactor
epydoc.objdoc.ObjDoc
:
-
ObjDoc
s 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
ObjDoc
s 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):
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.1'
|
__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:
|