Command-line interface for epydoc. Abbreviated Usage:
epydoc [options] NAMES...
NAMES... The Python modules to document.
--html Generate HTML output (default).
--latex Generate LaTeX output.
--pdf Generate pdf output, via LaTeX.
-o DIR, --output DIR The output directory.
--inheritance STYLE The format for showing inherited objects.
-V, --version Print the version of epydoc.
-h, --help Display a usage message.
Run "epydoc --help" for a complete option list. See the
epydoc(1) man page for more information.
Config Files
Configuration files can be specified with the --config
option. These files are read using ConfigParser. Configuration files may set options or
add names of modules to document. Option names are (usually) identical
to the long names of command line options. To specify names to
document, use any of the following option names:
module modules value values object objects
A simple example of a config file is:
[epydoc]
modules: sys, os, os.path, re
name: Example
graph: classtree
introspect: no
Verbosity Levels
The -v and -q options increase and
decrease verbosity, respectively. The default verbosity level is zero.
The verbosity levels are currently defined as follows:
Progress Markup warnings Warnings Errors
-3 none no no no
-2 none no no yes
-1 none no yes yes
0 (default) bar no yes yes
1 bar yes yes yes
2 list yes yes yes
parse_configfiles(configfiles,
options,
names)
| source code |
-
|
INHERITANCE_STYLES
-
- Value:
('grouped', 'listed', 'included')
|
|
GRAPH_TYPES
-
- Value:
('classtree', 'callgraph', 'umlclasstree')
|
|
ACTIONS
-
- Value:
('html', 'text', 'latex', 'dvi', 'ps', 'pdf', 'check')
|
|
_RERUN_LATEX_RE
-
- Value:
^LaTeX\s+Warning:\s+Label\(s\)\s+may\s+have\s+changed.\s+Rerun
|
|