epydoc.cli

Package epydoc :: Module cli |
[show private | hide private]
[frames | no frames]

## Module epydoc.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 `cli` to report its progress.

Function Summary
`None` | ``cli`()` Command line interface for epydoc.
| ``_check`(docmap, options)` Run completeness checks on the objects in the given documentation map.
| ``_check_css`(cssname)` If `cssname` is not valid, then issue an error and exit.
`None` | ``_help`(arg)` Display a speficied help message, and exit.
| ``_html`(docmap, options)` Create the HTML documentation for the objects in the given documentation map.
`list` of `module` | ``_import`(module_names, verbosity)` Return a list of the modules contained in the given files.
| ``_internal_error`(e)` 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.
`None` | ``_parse_args`()` Process the command line arguments; return a dictionary containing the relevant info.
| `_run(cmd, options)`
`None` | ``_usage`(exit_code)` Display a usage message.
| ``_usage_error`(estr, exit_code)` Issue an error message, and exit.
`None` | ``_version`()` 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. Returns: `None`

### _check(docmap, options) Run completeness checks on the objects in the given documentation map. By default, `_check` checks for docstrings in all public modules, classes, functions, and properties. Additional checks can be added with the `'tests'` option: `private`: Also checks private objects. `vars`: Also checks variables, parameters, and return values. Parameters: `docmap` - A documentation map containing the documentation for the objects whose API documentation should be created. `options` - Options from the command-line arguments. (type=`dict`)

### _check_css(cssname) If `cssname` is not valid, then issue an error and exit.

### _help(arg) Display a speficied help message, and exit. Parameters: `arg` - The name of the help message to display. Currently, only `"css"` and `"usage"` are recognized. (type=`string`) Returns: `None`

### _html(docmap, options) Create the HTML documentation for the objects in the given documentation map. Parameters: `docmap` - A documentation map containing the documentation for the objects whose API documentation should be created. `options` - Options from the command-line arguments. (type=`dict`)

### _import(module_names, verbosity) Parameters: `module_names` - The list of module filenames. (type=`list` of `string`) `verbosity` - Verbosity level for tracing output. (type=`int`) Returns: A list of the modules contained in the given files. Duplicates are removed. Order is preserved. (type=`list` of `module`)

### _internal_error(e=None) Print a warning message about an internal error. Returns: The return value from calling `func`

### _latex(docmap, options, format) Create the LaTeX documentation for the objects in the given documentation map. Parameters: `docmap` - A documentation map containing the documentation for the objects whose API documentation should be created. `options` - Options from the command-line arguments. (type=`dict`) `format` - One of `'latex'`, `'dvi'`, `'ps'`, or `'pdf'`.

### _make_docmap(modules, options) Construct the documentation map for the given modules. Parameters: `modules` - The modules that should be documented. (type=`list` of `Module`) `options` - Options from the command-line arguments. (type=`dict`)

### _parse_args() Process the command line arguments; return a dictionary containing the relevant info. Returns: A dictionary mapping from configuration parameters to values. If a parameter is specified on the command line, then that value is used; otherwise, a default value is used. Currently, the following configuration parameters are set: `target`, `modules`, `verbosity`, `prj_name`, `output`, `show_imports`, `frames`, `private`, `debug`, `top`, `list_classes_separately`, `docformat`, `inheritance`, `autogen_vars`, and `test`. (type=`None`)

### _usage(exit_code=1) Display a usage message. Parameters: `exit_code` - An exit status that will be passed to `sys.exit`. (type=`int`) Returns: `None`

### _usage_error(estr, exit_code=1) Issue an error message, and exit.

### _version() Display the version information, and exit. Returns: `None`

Variable Details

    ### DEBUG_LATEX_COMMAND Type: `str` Value:
        'echo x | latex %(tex)s'

    ### DVIPS_COMMAND Type: `str` Value:
        'dvips -q %(dvi)s -o %(ps)s -G0 -Ppdf'

    ### LATEX_COMMAND Type: `str` Value:
        "echo x | latex '\\batchmode\\input %(tex)s'"

    ### MAKEINDEX_COMMAND Type: `str` Value:
        'makeindex -q %(idx)s'

    ### PROFILE Whether or not to run the profiler. Type: `int` Value:
        0

    ### PS2PDF_COMMAND Type: `str` Value:
        'ps2pdf -sPAPERSIZE=letter -dMaxSubsetPct=100 -dSubsetFonts=true -dCom\
        patibilityLevel=1.2 -dEmbedAllFonts=true %(ps)s %(pdf)s'

    ### TESTS The lists of tests that can be run with `'epydoc --check'`. Type: `tuple` Value:
        ('basic', 'types', 'vars', 'private', 'authors', 'versions', 'all')

    ### _encountered_internal_error A global variable recording whether any internal errors have been detected. If this variable is set to true, then `cli` will issue a warning once it completes running. Type: `int` Value:
        0

Generated by Epydoc 2.1 on Sat Mar 20 17:46:18 2004 | http://epydoc.sf.net