epydoc - generate API documentation from Python docstrings

epydoc -h [topic]

epydoc -V

epydoc generates API documentation for Python modules and packages, based on their docstrings. A lightweight markup language called epytext 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.

The HTML API documentation produced by epydoc 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.

The LaTeX API documentation produced by epydoc consists of a main LaTeX file, and a LaTeX file for each module. If you use the --dvi, --ps, or --pdf options, then epydoc 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 \\include command. If you wish to include individual classes in other LaTeX documents, then use the --separate-classes option to produce a separate LaTeX file for each class.

epydoc 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 --tests option can be used to specify additional tests to perform.

This section describes Debian-specific behavior.

By default, the epydoc command runs using the default version of Python in /usr/bin/python. If /usr/bin/python is not found, the command works through a list of various other executables which should be available on a Debian system, i.e. /usr/bin/python2.2, /usr/bin/python2.3, etc. If no sensible python is found in the usual locations, the command falls back on the first python found in the user's $PATH.

The user may override the script's choice of python using the $PYTHONVER environment variable, i.e.

PYTHONVER=2.2 epydoc [...]

If $PYTHONVER is set, the command will use the first python$PYTHONVER found in the user's $PATH.

Note: in order to use epydoc with Python 2.1 or 2.2, you must have the appropriate python-xmlbase package (python2.1-xmlbase or python2.2-xmlbase) installed on your system as described in the package dependencies.

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.

ACTION SELECTION OPTIONS

--html

Generate HTML output. (default)

--latex

Generate LaTeX output.

--dvi

Generate dvi output. This option first creates LaTeX output, and then uses latex and makeindex to convert the LaTeX files into a single dvi file.

--ps

Generate postscript output. This option first creates LaTeX output, and then uses latex, makeindex, and dvips to convert the LaTeX files into a single postscript file.

--pdf

Generate Adobe Acrobat (pdf) output. This option first creates LaTeX output, and then uses latex, makeindex, dvips, and ps2pdf to convert the LaTeX files into a single pdf file.

--check

Perform completeness checks on the documentation.

HTML DOCUMENTATION GENERATION OPTIONS

modules...

The list of the modules that should be documented. Modules can be specified using module names (such as os.path), filenames (such as epydoc/epytext.py), or directory names (such as epydoc/). Directory names specify packages, and are expanded to include all sub-modules and sub-packages.

--builtins

Add the builtin modules (as defined by sys.builtin_module_names) to the list of modules to document.

-c sheet, --css sheet

CSS stylesheet for HTML files containing public API documentation. If sheet is a file, then the stylesheet is copied from that file; otherwise, sheet is taken to be the name of a built-in stylesheet. For a list of the built-in stylesheets, run epydoc --help css. If a CSS stylesheet is not specified, then the default stylesheet is used.

--docformat format

Set the default value for __docformat__ to format. __docformat__ 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 en for English). For a list of the markup languages currently recognized by epydoc, run epydoc --help docformat.

--help-file file

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.

--ignore-param-mismatch

Do not issue warnings when a method's parameters do not match the parameters of the base class method that it overrides.

--inheritance format

The format that should be used to display inherited methods, variables, and properties in the "summary" tables. If format is "grouped," then inherited objects are gathered into groups, based on which class that they are inherited from. If format is "listed," then inherited objects are listed in a short list at the end of the summary table. If format is "included," then inherited objects are mixed in with non-inherited objects. The default format for HTML output is "grouped."

-n name, --name name

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 --navlink option is not used.

--navlink html

HTML code for the homepage link on the navigation bar. If this HTML code contains any hyperlinks (<a href=...>), then it will be inserted verbatim. If it does not contain any hperlinks, and a project url is specified (with --url), then a hyperlink to the specified URL is added to the link.

--no-frames

Do not display the frames-based table of contents on the main API documentation page (index.html). This option just changes the default view; the user can still access the frames-based table of contents by clicking on frames in the navigation bar.

-o dir, --output dir, --target dir

The output directory for HTML files. By default, HTML files are written to the html directory.

--private, --no-private

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 "show private" and "hide private" 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 --no-private option is also useful if you want to generate documentation more quickly, since epydoc will only need to produce half as many HTML pages.

--private-css sheet

CSS stylesheet for HTML files containing private API documentation. If sheet is a file, then the stylesheet is copied from that file; otherwise, sheet is taken to be the name of a built-in stylesheet. For a list of the built-in stylesheets, run epydoc --help css. If a CSS stylesheet is not specified, then epydoc copies the stylesheet for public API documentation (see --css).

-q, --quiet

Produce quiet output. If -q is used multiple times, it produces successively more quiet output (by suppressing warning messages).

--show-imports

Include a list of the classes, functions, and variables that each module imports on the module documentation pages.

-t page, --top page

The top page for the documentation. page 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 "http:"); or one of the special names trees.html, indices.html, or help.html, indicating the corresponding API documentation pages.

-u url, --url url

The URL of the project's homepage. This URL is used by the homepage link on the navigation bar.

-v, --verbose

Produce verbose output. If -v is used multiple times, it produces successively more verbose output.

LATEX DOCUMENTATION GENERATION OPTIONS LaTeX documentation generation options are used when producing LaTeX, postscript (ps), or pdf output.

modules...

The list of the modules that should be documented. Modules can be specified using module names (such as os.path), filenames (such as epydoc/epytext.py), or directory names (such as epydoc/). Directory names specify packages, and are expanded to include all sub-modules and sub-packages.

--builtins

Add the builtin modules (as defined by sys.builtin_module_names) to the list of modules to document.

--docformat format

Set the default value for __docformat__ to format. __docformat__ 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 en for English). For a list of the markup languages currently recognized by epydoc, run epydoc --help docformat.

--ignore-param-mismatch

Do not issue warnings when a method's parameters do not match the parameters of the base class method that it overrides.

--inheritance format

The format that should be used to display inherited methods, variables, and properties. If format is "grouped," then inherited objects are gathered into groups, based on which class that they are inherited from. If format is "listed," then inherited objects are listed in a short list at the end of their section. If format is "included," then inherited objects are mixed in with non-inherited objects. The default format for LaTeX output is "listed."

-n name, --name name

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.

-o dir, --output dir, --target dir

The output directory. By default, HTML files are written to the html directory, and LaTeX files are written to the latex directory.

--private, --no-private

These options control whether documentation is generated for private objects. By default, LaTeX output only includes documentation for public objects.

-q, --quiet

Produce quiet output. If -q is used multiple times, it produces successively more quiet output (by suppressing warning messages).

--separate-classes

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.

-v, --verbose

Produce verbose output. If -v is used multiple times, it produces successively more verbose output.

DOCUMENTATION COMPLETENESS CHECKING OPTIONS The --check 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 --tests option.

modules...

The list of the modules whose documentation should be checked. Modules can be specified using module names (such as os.path), filenames (such as epydoc/epytext.py), or directory names (such as epydoc/). Directory names specify packages, and are expanded to include all sub-modules and sub-packages.

--ignore-param-mismatch

Do not issue warnings when a method's parameters do not match the parameters of the base class method that it overrides.

--private

Perform checks on private objects

-q, --quiet

Produce quiet output. If -q is used multiple times, it produces successively more quiet output (by suppressing warning messages).

--tests tests, --checks tests

Perform additional tests on the documentation. For a list of the additional tests that are available, run epydoc --help tests.

-v, --verbose

Produce verbose output. If -v is used multiple times, it produces successively more verbose output.

OTHER OPTIONS

-h, --help, --usage, -?

Display a usage message.

-h topic, --help topic

Display information about a specific topic. Currently, information is available about the following topics: css, version, and usage.

-V, --version

Print the version of Epydoc.

epydoc -n epydoc -u http://epydoc.sf.net epydoc/

Generate the HTML API documentation for the epydoc package and all of its submodules, and write the output to the html directory. In the headers and footers, use epydoc as the project name, and http://epydoc.sf.net as the project URL.

epydoc --pdf -n epydoc epydoc/

Generate the LaTeX API documentation for the epydoc package and all of its submodules, and write the output to the latex directory.

epydoc -o api --css blue --private-css green sys

Generate API documentation for the sys module, and write the output to the api directory. Use different stylesheets for the public and private versions of the documentation.

The HTML API documentation produced by epydoc consists of the following files:

index.html

The standard entry point for the documentation. Normally, index.html is a copy of the frames file (frames.html). But if the --no-frames option is used, then index.html 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).

module-module.html

The API documentation for a module. module is the complete dotted name of the module, such as sys or epydoc.epytext.

class-class.html

The API documentation for a class, exception, or type. class is the complete dotted name of the class, such as epydoc.epytext.Token or array.ArrayType.

trees.html

The module and class hierarchies.

indices.html

The term and identifier indices.

help.html

The help page for the project. This page explains how to use and navigate the webpage produced by epydoc.

frames.html

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.

toc.html

The top-level table of contents page. This page is displayed in the upper-left frame of frames.html, and provides links to the toc-everything.html and toc-module-module.html pages.

toc-everything.html

The table of contents for the entire project. This page is displayed in the lower-left frame of frames.html, and provides links to every class, type, exception, function, and variable defined by the project.

toc-module-module.html

The table of contents for a module. This page is displayed in the lower-left frame of frames.html, and provides links to every class, type, exception, function, and variable defined by the module. module is the complete dotted name of the module, such as sys or epydoc.epytext.

epydoc.css

The CSS stylesheet used to display all HTML pages.

By default, epydoc creates two subdirectories in the output directory: public and private. Each directory contains all of the files specified above. But if the --no-private option is used, then no subdirectories are created, and the public documentation is written directly to the output directory.

The LaTeX API documentation produced by epydoc consists of the following files:

api.pdf

An Adobe Acrobat (pdf) file containing the complete API documentation. This file is only generated if you use the --pdf option.

api.tex

The top-level LaTeX file. This file imports the other LaTeX files, to create a single unified document.

api.dvi

A dvi file containing the complete API documentation. This file is only generated if you use the --dvi option, the --ps option, or the --pdf option.

api.ps

A postscript file containing the complete API documentation. This file is only generated if you use the --ps option or the --pdf option.

module-module.tex

The API documentation for a module. module is the complete dotted name of the module, such as sys or epydoc.epytext.

class-class.tex

The API documentation for a class, exception, or type. class is the complete dotted name of the class, such as epydoc.epytext.Token or array.ArrayType. These class documentation files are only created if the --separate-classes option is used; otherwise, the documentation for each class is included in its module's documentation file.

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.

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:

Bad module name module

Epydoc attempted to import module, but module is not a valid name for a Python module.

Could not find a UID for link-target

Epydoc was unable to find the object referred to by an inline link construction (L{...}). This is usually caused by a typo in the link.

Could not import module

Epydoc attempted to import module, but it failed. This typically occurs when module raises an exception.

file does not exist

Epydoc attempted to import the module contained in file, but file does not exist.

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:

Bad link target.

The target specified for an inline link contruction (L{...}) is not well-formed. Link targets must be valid python identifiers.

Bad uri target.

The target specified for an inline uri contruction (U{...}) is not well-formed. This typically occurs if inline markup is nested inside the URI target.

Fields must be at the top level.

The list of fields (@param, etc.) is contained by some other block structure (such as a list or a section).

Fields must be the final elements.

The list of fields (@param, etc.) is not at the end of a docstring.

Headings must occur at top level.

The heading is contianed in some other block structure (such as a list).

Improper doctest block indentation.

The doctest block dedents past the indentation of its initial prompt line.

Improper heading indentation.

The heading for a section is not left-aligned with the paragraphs in the section that contains it.

Improper paragraph indentation.

The paragraphs within a block are not left-aligned. This error is often generated when plaintext docstrings are parsed using epytext.

Invalid escape.

An unknown escape sequence was used with the inline escape construction (E{...}).

Lists must be indented.

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.

Unbalanced '{'.

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).

Unbalanced '}'.

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).

Unknown inline markup tag.

An unknown tag was used with the inline markup construction ( x{...} ).

Wrong underline character for heading.

The underline character used for this section heading does not indicate an appopriate section level. The "=" character should be used to underline sections; "-" for subsections; and "~" for subsubsections.

Epytext warnings are caused by epytext docstrings that contain questionable or suspicious markup. Epytext warnings do not prevent the docstring in question from being parsed. Epydoc can generate the following epytext warnings:

Possible mal-formatted field item.

Epytext detected a line that looks like a field item, but is not correctly formatted. This typically occurs when the trailing colon (":") is not included in the field tag.

Possible heading typo.

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.

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:

@param for unknown parameter param.

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.

tag did not expect an argument.

The field tag tag was used with an argument, but it does not take one.

tag expected an argument.

The field tag tag was used without an argument, but it requires one.

@type for unknown parameter param.

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.

@type for unknown variable var.

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.

Unknown field tag tag.

A docstring contains a field with the unknown tag tag.

Redefinition of field.

Multiple field tags define the value of field in the same docstring, but field can only take a single value.

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:

The parameters of inhmethod do not match basemethod.

The parameters of the undocumented method inhmethod do not match the parameters of the base class method basemethod that it overrides. As a result, inhmethod does not inherit documentation from basemethod. If the difference in parameters is intentional, then you can eliminate the warning by adding a (possibly empty) docstring to inhmethod.

Docmap cannot add a type

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.

UID conflict detected: uid

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.

object appears in multiple builtin modules

While attempting to determine which module defines the builtin object object, 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.

object appears in multiple .py modules

While attempting to determine which module defines the builtin object object, 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.

object appears in multiple .so modules

While attempting to determine which module defines the builtin object object, 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.

Could not find a module for object

Epydoc was unable to determine which module defines object. If object is a function, then this will prevent epydoc from generating any documentation for object, since it does not know what page to put the documentation on. Otherwise, this will prevent the documentation for object from including a link to its containing module.

0

Successful program execution.

1

Usage error.

other

Internal error (Python exception).

Epydoc was written by Edward Loper. This man page was originally written by Moshe Zadka, and is currently maintained by Edward Loper. Debian-specific modifications were made by Kenneth J. Pronovici.

Report bugs to <edloper@gradient.cis.upenn.edu>.

epydocgui(1)

The epydoc webpage

<http://epydoc.sourceforge.net>

The epytext markup language manual

<http://epydoc.sourceforge.net/epytext.html>