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.

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

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'`.

Function Details

### cli() Command line interface for epydoc. 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')

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