File: epydoc-man.html

package info (click to toggle)
epydoc 2.1-8
links: PTS
area: main
in suites: sarge
size: 5,364 kB
ctags: 2,878
sloc: python: 9,010; makefile: 85; sh: 73
file content (1316 lines) | stat: -rw-r--r-- 31,087 bytes
parent folder | download | duplicates (2)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Manpage of EPYDOC</TITLE>
<STYLE TYPES="text/css">
DIV.section {margin-left:2cm}
</STYLE>
<link rel="stylesheet" href="epydoc.css" type="text/css"/></HEAD><BODY>






<A NAME="lbAB">
<H2>NAME</H2></A>

epydoc - generate API documentation from Python docstrings

<A NAME="lbAC">
<H2>SYNOPSIS</H2></A>

<DL COMPACT><DT>

<B>epydoc</B>

[<B>--html</B> | <B>--latex</B> | <B>--dvi</B> | <B>--ps</B> | <B>--pdf</B>]

[<B>-o</B>

<I>dir</I>]

[<B>--docformat</B>

<I>format</I>]

[<B>-n</B>

<I>name</I>]

[<B>-u</B>

<I>url</I>]

[<B>-t</B>

<I>page</I>]

[<B>-c</B>

<I>sheet</I>]

[<B>--private-css</B>

<I>sheet</I>]

[<B>--navlink</B>

<I>html</I>]

[<B>--help-file</B>

<I>file</I>]

[<B>--private</B>]

[<B>--no-private</B>]

[<B>--inheritance</B>

<I>style</I>]

[<B>--show-imports</B>]

[<B>--builtins</B>]

[<B>--ignore-param-mismatch</B>]

[<B>--separate-classes</B>]

[<B>-q</B>]

[<B>-v</B>]

<I>modules</I><B>...</B>

<DT>

<B>epydoc</B>

<B>--check</B>

[<B>--tests</B>

<B>tests</B>]

[<B>--private</B>]

[<B>--builtins</B>]

[<B>--ignore-param-mismatch</B>]

[<B>-q</B>]

[<B>-v</B>]

<I>modules</I><B>...</B>

</DL>
<P>

<B>epydoc -h</B>

[<I>topic</I>]

<P>

<B>epydoc -V</B>


<A NAME="lbAD">
<H2>DESCRIPTION</H2></A>

<B>epydoc</B>

generates API documentation for Python modules and packages, based on
their docstrings.  A lightweight markup language called
<B>epytext</B>

can be used to format docstrings, and to add information about
specific fields, such as parameters and instance variables.  Epydoc
also understands docstrings written in ReStructuredText, Javadoc, and
plaintext.  Currently, epydoc supports two basic output formats: HTML
and LaTeX.
<P>

The HTML API documentation produced by 
<B>epydoc</B>

consists of a set of HTML files.  Two subdirectories are created for
the public and private documentation.  Within each subdirectory,
every class and module is documented in its own file.  An index file,
a trees file, a help file, and a frames-based table of contents are
also created.
<P>

The LaTeX API documentation produced by
<B>epydoc</B>

consists of a main LaTeX file, and a LaTeX file for each module.  If
you use the
<B>--dvi</B>,

<B>--ps</B>,

or
<B>--pdf</B>

options, then
<B>epydoc</B>

will invoke external commands to convert the LaTeX output to the
requested format.  Note that the LaTeX files containing the
documentation for individual modules can be included as chapters or
sections of other LaTeX documents, using the LaTeX
<B>\\include</B>

command.  If you wish to include individual classes in other LaTeX
documents, then use the
<B>--separate-classes</B>

option to produce a separate LaTeX file for each class.
<P>

<B>epydoc</B>

can also be used to check the completeness of the API documentation.
By default, it checks that every public package, module, class,
method, and function has a docstring description.  The
<B>--tests</B>

option can be used to specify additional tests to perform.

<A NAME="lbAE">
<H2>OPTIONS</H2></A>

Options are divided into five categories: action selection options;
HTML documentation generation options; LaTeX documentation generation
options; documentation checking options; and other options.  All
options must preceed the list of modules.
<P>

<B>ACTION SELECTION OPTIONS</B>

<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>--html</B>

<DD>
Generate HTML output. (default)
<DT><B>--latex</B>

<DD>
Generate LaTeX output.
<DT><B>--dvi</B>

<DD>
Generate dvi output.  This option first creates LaTeX output, and then
uses
<B>latex</B>

and
<B>makeindex</B>

to convert the LaTeX files into a single
<B>dvi</B>

file.
<DT><B>--ps</B>

<DD>
Generate postscript output.  This option first creates LaTeX output,
and then uses
<B>latex</B>,

<B>makeindex</B>,

and
<B>dvips</B>

to convert the LaTeX files into a single postscript file.
<DT><B>--pdf</B>

<DD>
Generate Adobe Acrobat
(<B>pdf</B>)

output.  This option first creates LaTeX output, and then uses
<B>latex</B>,

<B>makeindex</B>,

<B>dvips</B>,

and
<B>ps2pdf</B>

to convert the LaTeX files into a single
<B>pdf</B>

file.
<DT><B>--check</B>

<DD>
Perform completeness checks on the documentation.
</DL></DL>

<P>

<B>HTML DOCUMENTATION GENERATION OPTIONS </B>

<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><I>modules</I>...

<DD>
The list of the modules that should be documented.  Modules can be
specified using module names (such as
<B>os.path</B>),

filenames (such as
<B>epydoc/epytext.py</B>),

or directory names (such as
<B>epydoc/</B>).

Directory names specify packages, and are expanded to include
all sub-modules and sub-packages.
<DT><B>--builtins</B>

<DD>
Add the builtin modules (as defined by sys.builtin_module_names) to
the list of modules to document.
<DT><B>-c </B><I>sheet</I><B>, --css </B><I>sheet</I>

<DD>
CSS stylesheet for HTML files containing public API documentation.  If
<I>sheet</I>

is a file, then the stylesheet is copied from that file; otherwise,
<I>sheet</I>

is taken to be the name of a built-in stylesheet.  For a list of
the built-in stylesheets, run
<B>epydoc --help css</B>.

If a CSS stylesheet is not specified, then the default stylesheet is
used.
<DT><B>--docformat </B><I>format</I>

<DD>
Set the default value for
<B>__docformat__</B>

to
<I>format</I>.

<B>__docformat__</B>

is a module variable that specifies the markup language for the
docstrings in a module.  Its value consists of the name of a markup
language, optionally followed by a language code (such as
<B>en</B>

for English).  For a list of the markup languages currently recognized
by epydoc, run
<B>epydoc --help docformat</B>.

<DT><B>--help-file </B><I>file</I>

<DD>
A file containing the body of the help page for the HTML output.
Navigation bars will be added at the top and bottom of this help file.
If no file is specified, then a default help file is used.
<DT><B>--ignore-param-mismatch</B>

<DD>
Do not issue warnings when a method's parameters do not match the
parameters of the base class method that it overrides.
<DT><B>--inheritance </B><I>format</I>

<DD>
The format that should be used to display inherited methods,
variables, and properties in the &quot;summary&quot; tables.
If
<I>format</I>

is &quot;grouped,&quot; then inherited objects are gathered into groups, based
on which class that they are inherited from.  If
<I>format</I>

is &quot;listed,&quot; then inherited objects are listed in a short list at the
end of the summary table.  If
<I>format</I>

is &quot;included,&quot; then inherited objects are mixed in with non-inherited
objects.  The default format for HTML output is &quot;grouped.&quot;
<DT><B>-n </B><I>name</I><B>, --name </B><I>name</I>

<DD>
The name of the project whose documentation is being generated.  This
is used in the index page's title, and in the help page.  It is also
used to create the homepage link on the navigation bar, if the
<B>--navlink</B>

option is not used.
<DT><B>--navlink </B><I>html</I>

<DD>
HTML code for the homepage link on the navigation bar.  If this HTML
code contains any hyperlinks
(<B>&lt;a href=...&gt;</B>),

then it will be inserted verbatim.  If
it does not contain any hperlinks, and a project url is specified
(with
<B>--url</B>),

then a hyperlink to the specified URL is added to the link.
<DT><B>--no-frames</B>

<DD>
Do not display the frames-based table of contents on the main
API documentation page
(<B>index.html</B>).

This option just changes the default view; the user can still access
the frames-based table of contents by clicking on
<B>frames</B>

in the navigation bar.
<DT><B>-o </B><I>dir</I><B>, --output </B><I>dir</I><B>, --target </B><I>dir</I>

<DD>
The output directory for HTML files.  By default, HTML files are
written to the
<B>html</B>

directory.
<DT><B>--private, --no-private</B>

<DD>
These options control whether documentation is generated for private
objects.  By default, HTML documentation includes private objects, and
users can choose whether to view private objects or not, by clicking
on &quot;show private&quot; and &quot;hide private&quot; links.  But if you want to
discourage users from directly accessing private objects, then you may
prefer not to generate documentation for private objects.  The
<B>--no-private</B>

option is also useful if you want to generate documentation more
quickly, since epydoc will only need to produce half as many HTML
pages.
<DT><B>--private-css </B><I>sheet</I>

<DD>
CSS stylesheet for HTML files containing private API documentation.
If
<I>sheet</I>

is a file, then the stylesheet is copied from that file;
otherwise, 
<I>sheet</I>

is taken to be the name of a built-in stylesheet.  For a list of the
built-in stylesheets, run 
<B>epydoc --help css</B>.

If a CSS stylesheet is not specified, then epydoc
copies the stylesheet for public API documentation (see
<B>--css</B>).

<DT><B>-q, --quiet</B>

<DD>
Produce quiet output.  If
<B>-q</B>

is used multiple times, it produces successively more quiet output (by
suppressing warning messages).
<DT><B>--show-imports</B>

<DD>
Include a list of the classes, functions, and variables that each
module imports on the module documentation pages.
<DT><B>-t </B><I>page</I><B>, --top </B><I>page</I>

<DD>
The top page for the documentation. 
<I>page</I>

can be the name of a documented module or a class; the name of a file
containing a documented module; an absolute URL (starting
with &quot;http:&quot;); or one of the special names
<B>trees.html</B>,

<B>indices.html</B>, or

<B>help.html</B>,

indicating the corresponding API documentation pages.
<DT><B>-u </B><I>url</I><B>, --url </B><I>url</I>

<DD>
The URL of the project's homepage.  This URL is used by the homepage
link on the navigation bar.
<DT><B>-v, --verbose</B>

<DD>
Produce verbose output.  If
<B>-v</B>

is used multiple times, it produces successively more verbose output.
</DL></DL>

<P>

<B>LATEX DOCUMENTATION GENERATION OPTIONS</B>

<DL COMPACT><DT><DD>
LaTeX documentation generation options are used when producing LaTeX,
postscript (ps), or pdf output.
<DL COMPACT>
<DT><I>modules</I>...

<DD>
The list of the modules that should be documented.  Modules can be
specified using module names (such as
<B>os.path</B>),

filenames (such as
<B>epydoc/epytext.py</B>),

or directory names (such as
<B>epydoc/</B>).

Directory names specify packages, and are expanded to include
all sub-modules and sub-packages.
<DT><B>--builtins</B>

<DD>
Add the builtin modules (as defined by sys.builtin_module_names) to
the list of modules to document.
<DT><B>--docformat </B><I>format</I>

<DD>
Set the default value for
<B>__docformat__</B>

to
<I>format</I>.

<B>__docformat__</B>

is a module variable that specifies the markup language for the
docstrings in a module.  Its value consists of the name of a markup
language, optionally followed by a language code (such as
<B>en</B>

for English).  For a list of the markup languages currently recognized
by epydoc, run
<B>epydoc --help docformat</B>.

<DT><B>--ignore-param-mismatch</B>

<DD>
Do not issue warnings when a method's parameters do not match the
parameters of the base class method that it overrides.
<DT><B>--inheritance </B><I>format</I>

<DD>
The format that should be used to display inherited methods,
variables, and properties.
If
<I>format</I>

is &quot;grouped,&quot; then inherited objects are gathered into groups, based
on which class that they are inherited from.  If
<I>format</I>

is &quot;listed,&quot; then inherited objects are listed in a short list at the
end of their section.  If
<I>format</I>

is &quot;included,&quot; then inherited objects are mixed in with non-inherited
objects.  The default format for LaTeX output is &quot;listed.&quot;
<DT><B>-n </B><I>name</I><B>, --name </B><I>name</I>

<DD>
The name of the project whose documentation is being generated.  This
is used on the title page, in the page header, and in the pdf metadata.
<DT><B>-o </B><I>dir</I><B>, --output </B><I>dir</I><B>, --target </B><I>dir</I>

<DD>
The output directory.  By default, HTML files are
written to the
<B>html</B>

directory, and LaTeX files are written to the
<B>latex</B>

directory.
<DT><B>--private, --no-private</B>

<DD>
These options control whether documentation is generated for private
objects.  By default, LaTeX output only includes documentation for
public objects.
<DT><B>-q, --quiet</B>

<DD>
Produce quiet output.  If
<B>-q</B>

is used multiple times, it produces successively more quiet output (by
suppressing warning messages).
<DT><B>--separate-classes</B>

<DD>
Describe all classes in a separate section of the documentation,
instead of including them in the documentation for their modules.
This creates a separate LaTeX file for each class, so it can also be
useful if you want to include the documentation for one or two classes
as sections of your own LaTeX document.
<DT><B>-v, --verbose</B>

<DD>
Produce verbose output.  If
<B>-v</B>

is used multiple times, it produces successively more verbose output.
</DL></DL>

<P>

<B>DOCUMENTATION COMPLETENESS CHECKING OPTIONS</B>

<DL COMPACT><DT><DD>
The
<B>--check</B>

option is used to perform completeness checks on the documentation of
your project.  By default, epydoc checks to make sure that all public
objects have docstrings.  Additional checks can be added with the
<B>--tests</B>

option.
<DL COMPACT>
<DT><I>modules</I>...

<DD>
The list of the modules whose documentation should be checked.
Modules can  be specified using module names (such as
<B>os.path</B>),

filenames (such as
<B>epydoc/epytext.py</B>),

or directory names (such as
<B>epydoc/</B>).

Directory names specify packages, and are expanded to include
all sub-modules and sub-packages.
<DT><B>--ignore-param-mismatch</B>

<DD>
Do not issue warnings when a method's parameters do not match the
parameters of the base class method that it overrides.
<DT><B>--private</B>

<DD>
Perform checks on private objects
<DT><B>-q, --quiet</B>

<DD>
Produce quiet output.  If
<B>-q</B>

is used multiple times, it produces successively more quiet output (by
suppressing warning messages).
<DT><B>--tests </B><I>tests</I><B>, --checks </B><I>tests</I>

<DD>
Perform additional tests on the documentation.  For a list of the
additional tests that are available, run
<B>epydoc --help tests</B>.

<DT><B>-v, --verbose</B>

<DD>
Produce verbose output.  If
<B>-v</B>

is used multiple times, it produces successively more verbose output.
</DL></DL>

<P>

<B>OTHER OPTIONS</B>

<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>-h, --help, --usage, -?</B>

<DD>
Display a usage message.
<DT><B>-h </B><I>topic</I><B>, --help </B><I>topic</I>

<DD>
Display information about a specific topic.  Currently,
information is available about the following topics:
<B>css</B>, <B>version</B>, and <B>usage</B>.

<DT><B>-V, --version</B>

<DD>
Print the version of Epydoc.
</DL></DL>


<A NAME="lbAF">
<H2>EXAMPLES</H2></A>

<DL COMPACT>
<DT><B>epydoc -n </B>epydoc<B> -u </B><A HREF="http://epydoc.sf.net">http://epydoc.sf.net</A> epydoc/

<DD>
Generate the HTML API documentation for the epydoc package and all of
its submodules, and write the output to the
<B>html</B>

directory.  In the headers and footers, use
<B>epydoc</B>

as the project name, and
<B><A HREF="http://epydoc.sf.net">http://epydoc.sf.net</A></B>

as the project URL.
<DT><B>epydoc --pdf -n </B>epydoc<B> epydoc/</B>

<DD>
Generate the LaTeX API documentation for the epydoc package and all of
its submodules, and write the output to the
<B>latex</B>

directory.
<DT><B>epydoc -o api</B> --css <B>blue</B> --private-css <B>green sys</B>

<DD>
Generate API documentation for the
<B>sys</B>

module, and write the output to the
<B>api</B>

directory.  Use different stylesheets for the public and private
versions of the documentation.

</DL>
<A NAME="lbAG">
<H2>HTML FILES</H2></A>

The HTML API documentation produced by 
<B>epydoc</B>

consists of the following files:
<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>index.html</B>

<DD>
The standard entry point for the documentation.  Normally,
<B>index.html</B>

is a copy of the frames file
(<B>frames.html</B>).

But if the
<B>--no-frames</B>

option is used, then
<B>index.html</B>

is a copy of the API documentation home page, which is normally the
documentation page for the top-level package or module (or the trees
page if there is no top-level package or module).
<DT><I>module</I><B>-module.html</B>

<DD>
The API documentation for a module.  
<I>module</I>

is the complete dotted name of the module, such as 
<B>sys</B>

or
<B>epydoc.epytext</B>.

<DT><I>class</I><B>-class.html</B>

<DD>
The API documentation for a class, exception, or type.
<I>class</I>

is the complete dotted name of the class, such as
<B>epydoc.epytext.Token</B>

or
<B>array.ArrayType</B>.

<DT><B>trees.html</B>

<DD>
The module and class hierarchies.
<DT><B>indices.html</B>

<DD>
The term and identifier indices.
<DT><B>help.html</B>

<DD>
The help page for the project.  This page explains how to use and
navigate the webpage produced by epydoc.
<DT><B>frames.html</B>

<DD>
The main frames file.  Two frames on the left side of the window
contain a table of contents, and the main frame on the right side of
the window contains API documentation pages.
<DT><B>toc.html</B>

<DD>
The top-level table of contents page.  This page is displayed in the
upper-left frame of
<B>frames.html</B>,

and provides links to the
<B>toc-everything.html</B>

and 
<B>toc-</B><I>module</I><B>-module.html</B>

pages.
<DT><B>toc-everything.html</B>

<DD>
The table of contents for the entire project.  This page is displayed
in the lower-left frame of
<B>frames.html</B>,

and provides links to every class, type, exception, function, and
variable defined by the project.
<DT><B>toc-</B><I>module</I><B>-module.html</B>

<DD>
The table of contents for a module.  This page is displayed in the
lower-left frame of
<B>frames.html</B>,

and provides links to every class, type, exception, function, and
variable defined by the module.
<I>module</I>

is the complete dotted name of the module, such as 
<B>sys</B>

or
<B>epydoc.epytext</B>.

<DT><B>epydoc.css</B>

<DD>
The CSS stylesheet used to display all HTML pages.
</DL></DL>

<P>

By default,
<B>epydoc</B>

creates two subdirectories in the output directory:
<B>public</B>

and
<B>private</B>.

Each directory contains all of the files specified above.
But if the
<B>--no-private</B>

option is used, then no subdirectories are created, and the public
documentation is written directly to the output directory.

<A NAME="lbAH">
<H2>LATEX FILES</H2></A>

The LaTeX API documentation produced by
<B>epydoc</B>

consists of the following files:
<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>api.pdf</B>

<DD>
An Adobe Acrobat (pdf) file containing the complete API documentation.
This file is only generated if you use the
<B>--pdf</B>

option.
<DT><B>api.tex</B>

<DD>
The top-level LaTeX file.  This file imports the other LaTeX files, to
create a single unified document.
<DT><B>api.dvi</B>

<DD>
A dvi file containing the complete API documentation.  This file is
only generated if you use the 
<B>--dvi</B>

option, the
<B>--ps</B>

option, or the
<B>--pdf</B>

option.
<DT><B>api.ps</B>

<DD>
A postscript file containing the complete API documentation.  This
file is only generated if you use the
<B>--ps</B>

option or the
<B>--pdf</B>

option.
<DT><I>module</I><B>-module.tex</B>

<DD>
The API documentation for a module.
<I>module</I>

is the complete dotted name of the module, such as
<B>sys or</B>

<B>epydoc.epytext</B>.

<DT><I>class</I><B>-class.tex</B>

<DD>
The API documentation for a class, exception, or type.
<I>class</I>

is the complete dotted name of the class, such as
<B>epydoc.epytext.Token</B>

or array.ArrayType.  These class documentation files are only created
if the
<B>--separate-classes</B>

option is used; otherwise, the documentation for each class is
included in its module's documentation file.
</DL></DL>


<A NAME="lbAI">
<H2>DIAGNOSTICS</H2></A>

Errors are divided into five categories: import errors; epytext
errors; epytext warnings; field warnings; and inspection errors.
Whenver epydoc encounters an error, it issues a warning message that
describes the error, and attempts to continue generating
documentation.
<P>

Import errors indicate that epydoc was unable to import a module.
Import errors typically prevent epydoc from generating documentation
for the module in question.  Epydoc can generate the following import
errors:
<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>Bad module name </B><I>module</I>

<DD>
Epydoc attempted to import
<I>module</I>,

but
<I>module</I>

is not a valid name for a Python module.
<DT><B>Could not find a UID for </B><I>link-target</I>

<DD>
Epydoc was unable to find the object referred to by an inline link
construction
(<B>L{...}</B>).

This is usually caused by a typo in the link.
<DT><B>Could not import </B><I>module</I>

<DD>
Epydoc attempted to import
<I>module</I>,

but it failed.  This typically occurs when
<I>module</I>

raises an exception.
<DT><I>file</I><B> does not exist</B>

<DD>
Epydoc attempted to import the module contained in
<I>file</I>,

but
<I>file</I>

does not exist.
</DL></DL>

<P>

Epytext errors are caused by epytext docstrings that contain invalid
markup.  Whenever an epytext error is detected, the docstring in
question is treated as a plaintext docstring.  Epydoc can generate the
following epytext errors:
<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>Bad link target.</B>

<DD>
The target specified for an inline link contruction
(<B>L{...}</B>)

is not well-formed.  Link targets must be valid python identifiers.
<DT><B>Bad uri target.</B>

<DD>
The target specified for an inline uri contruction
(<B>U{...}</B>)

is not well-formed.  This typically occurs if inline markup is nested
inside the URI target.  
<DT><B>Fields must be at the top level.</B>

<DD>
The list of fields
(<B>@param</B>, etc.)

is contained by some other
block structure (such as a list or a section).
<DT><B>Fields must be the final elements.</B>

<DD>
The list of fields
(<B>@param</B>, etc.)

is not at the end of a docstring.
<DT><B>Headings must occur at top level.</B>

<DD>
The heading is contianed in some other block structure (such as a
list).
<DT><B>Improper doctest block indentation.</B>

<DD>
The doctest block dedents past the indentation of its initial prompt
line.
<DT><B>Improper heading indentation.</B>

<DD>
The heading for a section is not left-aligned with the paragraphs in
the section that contains it.
<DT><B>Improper paragraph indentation.</B>

<DD>
The paragraphs within a block are not left-aligned.  This error is
often generated when plaintext docstrings are parsed using epytext.
<DT><B>Invalid escape.</B>

<DD>
An unknown escape sequence was used with the inline escape construction
(<B>E{...}</B>).

<DT><B>Lists must be indented.</B>

<DD>
An unindented line immediately following a paragraph starts with a
list bullet.  Epydoc is not sure whether you meant to start a new list
item, or meant for a paragraph to include a word that looks like a
bullet.  If you intended the former, then indent the list.  If you
intended the latter, then change the word-wrapping of the paragraph,
or escape the first character of the word that looks like a bullet.
<DT><B>Unbalanced '{'.</B>

<DD>
The docstring contains unbalanced braces.  Epytext requires that all
braces must be balanced.  To include a single unbalanced brace, use
the escape sequences E{lb} (left brace) and E{rb} (right brace).
<DT><B>Unbalanced '}'.</B>

<DD>
The docstring contains unbalanced braces.  Epytext requires that all
braces must be balanced.  To include a single unbalanced brace, use
the escape sequences E{lb} (left brace) and E{rb} (right brace).
<DT><B>Unknown inline markup tag.</B>

<DD>
An unknown tag was used with the inline markup construction (
<I>x</I><B>{...}</B>

).
<DT><B>Wrong underline character for heading.</B>

<DD>
The underline character used for this section heading does not
indicate an appopriate section level.  The &quot;=&quot; character should be
used to underline sections; &quot;-&quot; for subsections; and &quot;~&quot; for
subsubsections.
</DL></DL>

<P>

Epytext warnings are caused by epytext docstrings that contain
questionable or suspicious markup.  Epytext warnings do
<B>not</B>

prevent the docstring in question from being parsed.  Epydoc can
generate the following epytext warnings:
<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>Possible mal-formatted field item.</B>

<DD>
Epytext detected a line that looks like a field item, but is not
correctly formatted.  This typically occurs when the trailing colon
(&quot;:&quot;) is not included in the field tag.
<DT><B>Possible heading typo.</B>

<DD>
Epytext detected a pair of lines that looks like a heading, but the
number of underline characters does not match the number of characters
in the heading.  The number of characters in these two lines must
match exactly for them to be considered a heading.
</DL></DL>

<P>

Field warnings are caused by epytext docstrings containing invalid
fields.  The contents of the invalid field are generally ignored.  
Epydoc can generate the following field warnings:
<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>@param for unknown parameter </B><I>param</I><B>.</B>

<DD>
A @param field was used to specify the type for a parameter that is
not included in the function's signature.  This is typically caused by
a typo in the parameter name.
<DT><I>tag</I><B> did not expect an argument.</B>

<DD>
The field tag
<I>tag</I>

was used with an argument, but it does not take one.
<DT><I>tag</I><B> expected an argument.</B>

<DD>
The field tag
<I>tag</I>

was used without an argument, but it requires one.
<DT><B>@type for unknown parameter </B><I>param</I><B>.</B>

<DD>
A @type field was used to specify the type for a parameter that is not
included in the function's signature.  This is typically
caused by a typo in the parameter name.
<DT><B>@type for unknown variable </B><I>var</I><B>.</B>

<DD>
A @type field was used to specify the type for a variable, but no
other information is known about the variable.  This is typically
caused by a typo in the variable name.
<DT><B>Unknown field tag </B><I>tag</I><B>.</B>

<DD>
A docstring contains a field with the unknown tag
<I>tag</I>.

<DT><B>Redefinition of </B><I>field</I><B>.</B>

<DD>
Multiple field tags define the value of
<I>field</I>

in the same docstring, but
<I>field</I>

can only take a single value.
</DL></DL>

<P>

Inspection errors are generated if epydoc encounters problems while
attempting to inspect the properties of a documented object.  Most of
inspection errors do not prevent epydoc from documenting the object in
question.  Epydoc can generate the following inspection errors:
<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>The parameters of </B><I>inhmethod</I><B> do not match </B><I>basemethod</I><B>.</B>

<DD>
The parameters of the undocumented method
<I>inhmethod </I>

do not match the parameters of the base class method
<I>basemethod</I>

that it overrides.  As a result,
<I>inhmethod</I>

does not inherit documentation from
<I>basemethod</I>.

If the difference in parameters is intentional, then you can eliminate
the warning by adding a (possibly empty) docstring to
<I>inhmethod</I>.

<DT><B>Docmap cannot add a </B><I>type</I>

<DD>
Epydoc attempted to document an object with an unknown type.  This
error is typically generated by packages and modules that manipulate
the import mechanism, such that importing a module produces some other
type of object.
<DT><B>UID conflict detected: </B><I>uid</I>

<DD>
Two different objects were assigned the same unique identifier by
epydoc.  This can cause epydoc to substitute the documentation of one
object with the documentation of another object that is assigned the
same unique identifier.  However, this will usually only cause
problems if the two objects with the same unique identifiers are both
modules or classes, in which case the API documentation page for one
object will overwrite the API documentation page for the other object.
<DT><I>object</I><B> appears in multiple builtin modules</B>

<DD>
While attempting to determine which module defines the builtin object
<I>object</I>,

epydoc encountered multiple candidates, and was unable to decide which
candidate was correct.  In this case, epydoc arbitrarily chooses the
first candidate that it finds.
<DT><I>object</I><B> appears in multiple .py modules</B>

<DD>
While attempting to determine which module defines the builtin object
<I>object</I>,

epydoc encountered multiple candidates, and was unable to decide which
candidate was correct.  In this case, epydoc arbitrarily chooses the
first candidate that it finds.
<DT><I>object</I><B> appears in multiple .so modules</B>

<DD>
While attempting to determine which module defines the builtin object
<I>object</I>,

epydoc encountered multiple candidates, and was unable to decide which
candidate was correct.  In this case, epydoc arbitrarily chooses the
first candidate that it finds.
<DT><B>Could not find a module for </B><I>object</I>

<DD>
Epydoc was unable to determine which module defines 
<I>object</I>.

If
<I>object</I>

is a function, then this will prevent epydoc from generating any
documentation for
<I>object</I>,

since it does not know what page to put the documentation on.
Otherwise, this will prevent the documentation for
<I>object</I>

from including a link to its containing module.
</DL></DL>


<A NAME="lbAJ">
<H2>EXIT STATUS</H2></A>

<DL COMPACT>
<DT><B>0</B>

<DD>
Successful program execution.
<DT><B>1</B>

<DD>
Usage error.
<DT><B>other</B>

<DD>
Internal error (Python exception).

</DL>
<A NAME="lbAK">
<H2>AUTHOR</H2></A>

Epydoc was written by Edward Loper.  This man page was originally
written by Moshe Zadka, and is currently maintained by Edward Loper.

<A NAME="lbAL">
<H2>BUGS</H2></A>

Report bugs to &lt;<A HREF="mailto:edloper@gradient.cis.upenn.edu">edloper@gradient.cis.upenn.edu</A>&gt;.

<A NAME="lbAM">
<H2>SEE ALSO</H2></A>

<B><A HREF="epydocgui-man.html">epydocgui</A></B>(1)

<DL COMPACT>
<DT><B>The epydoc webpage</B>

<DD>
&lt;<A HREF="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</A>&gt;
<DT><B>The epytext markup language manual</B>

<DD>
&lt;<A HREF="http://epydoc.sourceforge.net/epytext.html">http://epydoc.sourceforge.net/epytext.html</A>&gt;
</DL>

<HR>
<A NAME="index"><H2>Index</H2></A>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">OPTIONS</A><DD>
<DT><A HREF="#lbAF">EXAMPLES</A><DD>
<DT><A HREF="#lbAG">HTML FILES</A><DD>
<DT><A HREF="#lbAH">LATEX FILES</A><DD>
<DT><A HREF="#lbAI">DIAGNOSTICS</A><DD>
<DT><A HREF="#lbAJ">EXIT STATUS</A><DD>
<DT><A HREF="#lbAK">AUTHOR</A><DD>
<DT><A HREF="#lbAL">BUGS</A><DD>
<DT><A HREF="#lbAM">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
man2html,
using the manual pages.<BR>
Time: 06:59:25 GMT, July 21, 2003
</BODY>
</HTML>