[show private | hide private]

Module epydoc.cli

Command-line interface for epydoc.

Usage:
   epydoc [-o DIR] [-n NAME] [-p] [-c SHEET] [-v] MODULE...
   epydoc --check [-p] [-v] MODULE...
   epydoc --help
   epydoc --version

   MODULE...
       List of filenames containing modules to process.  When
       documenting packages, the filename must include the package
       directory (i.e., you can't run epydoc within the package
       directory, using relative filenames).
       
   --help, --usage, -h, -?
       Display this usage message.

   --version, -V
       Print the version of epydoc.

   -o DIR, --output DIR, --target DIR
       Output directory for HTML files
       
   -n NAME, --name NAME
       Project name (for HTML header/footer)

   -u URL, --url URL
       Project URL (for HTML header/footer)

   -c SHEET, --css SHEET
       CSS stylesheet for HTML files.  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".

   --show-imports
       Include a list of the classes and functions that each module
       imports on the module documentation pages.
       
   --check
       Perform completeness checks on the documentation

   -p
       Check private objects (those that start with _)

   -v, --verbose
       Produce verbose output

   -vv, -vvv, -vvvv
       Produce successively more verbose output

   -q, --quiet
       Supress output of epytext warnings and errors.

Function Summary
None cli()
Command line interface for epydoc.

Function Details

cli

cli()

Command line interface for epydoc.
Returns:
None

Generated by Epydoc on Sun Oct 6 03:32:11 2002 http://epydoc.sf.net