| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module cli | 
 | 
Command-line interface for epydoc.
Usage:
epydoc [OPTIONS] MODULES...
    MODULES...                The Python modules to document.
    --html                    Generate HTML output (default).
    --latex                   Generate LaTeX output.
    --pdf                     Generate pdf output, via LaTeX.
    --check                   Run documentation completeness checks.
    -o DIR, --output DIR      The output directory.
    -n NAME, --name NAME      The documented project's name.
    -u URL, --url URL         The documented project's url.
    -t PAGE, --top PAGE       The top page for the HTML documentation.
    -c SHEET, --css SHEET     CSS stylesheet for HTML files.
    --private-css SHEET       CSS stylesheet for private objects.
    --inheritance STYLE       The format for showing inherited objects.
    -V, --version             Print the version of epydoc.
    -h, -?, --help, --usage   Display this usage message.
    -h TOPIC, --help TOPIC    Display information about TOPIC (docformat,
                              css, inheritance, usage, or version).
See the epydoc(1) man page for a complete list of options.
| Classes | |
|---|---|
| _Progress | The progress meter that is used by clito report its 
progress. | 
| Function Summary | |
|---|---|
| None | Command line interface for epydoc. | 
| Run completeness checks on the objects in the given documentation map. | |
| If cssnameis not valid, then issue an error and 
exit. | |
| None | Display a speficied help message, and exit. | 
| Create the HTML documentation for the objects in the given documentation map. | |
| listofmodule | Return a list of the modules contained in the given files. | 
| Print a warning message about an internal error. | |
| Create the LaTeX documentation for the objects in the given documentation map. | |
| Construct the documentation map for the given modules. | |
| None | Process the command line arguments; return a dictionary containing the relevant info. | 
| _run(cmd,
          options) | |
| None | Display a usage message. | 
| Issue an error message, and exit. | |
| None | Display the version information, and exit. | 
| Variable Summary | |
|---|---|
| str | DEBUG_LATEX_COMMAND='echo x | latex %(tex)s'            | 
| str | DVIPS_COMMAND='dvips -q %(dvi)s -o %(ps)s -G0 -Ppdf'    | 
| str | LATEX_COMMAND="echo x | latex '\\batchmode\\input %(te... | 
| str | MAKEINDEX_COMMAND='makeindex -q %(idx)s'                | 
| int | PROFILE: Whether or not to run the profiler. | 
| str | PS2PDF_COMMAND='ps2pdf -sPAPERSIZE=letter -dMaxSubsetP... | 
| tuple | TESTS: The lists of tests that can be run with'epydoc 
--check'. | 
| int | _encountered_internal_error: A global variable recording whether any internal errors have been 
detected. | 
| Function Details | 
|---|
| cli()Command line interface for epydoc.
 | 
| _check(docmap, options)Run completeness checks on the objects in the given documentation map. By default,_checkchecks for docstrings in all 
  public modules, classes, functions, and properties. Additional checks 
  can be added with the'tests'option:
 
 | 
| _check_css(cssname)Ifcssnameis not valid, then issue an error and 
  exit. | 
| _help(arg)Display a speficied help message, and exit.
 | 
| _html(docmap, options)Create the HTML documentation for the objects in the given documentation map.
 | 
| _import(module_names, verbosity)
 | 
| _internal_error(e=None)Print a warning message about an internal error.
 | 
| _latex(docmap, options, format)Create the LaTeX documentation for the objects in the given documentation map.
 | 
| _make_docmap(modules, options)Construct the documentation map for the given modules.
 | 
| _parse_args()Process the command line arguments; return a dictionary containing the relevant info.
 | 
| _usage(exit_code=1)Display a usage message.
 | 
| _usage_error(estr, exit_code=1)Issue an error message, and exit. | 
| _version()Display the version information, and exit.
 | 
| Variable Details | 
|---|
| DEBUG_LATEX_COMMAND
 | 
| DVIPS_COMMAND
 | 
| LATEX_COMMAND
 | 
| MAKEINDEX_COMMAND
 | 
| PROFILEWhether or not to run the profiler.
 | 
| PS2PDF_COMMAND
 | 
| TESTSThe lists of tests that can be run with'epydoc 
--check'.
 | 
| _encountered_internal_errorA global variable recording whether any internal errors have been detected. If this variable is set to true, thencliwill 
issue a warning once it completes running.
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:18 2004 | http://epydoc.sf.net |