eric3-doc(1)

NAME

eric3-doc - eric3 documentation generator

SYNOPSIS

eric3-doc [options] files...
where files can be be either Python modules,  package  directories or ordinary directories.

DESCRIPTION

Arraystrings or as documentation comments. For Quixote Template file
(PTL) only documentation comments are available due to the inner
workings of Quixote. Documentation comments start with the string
###, followed by the contents and ended by ###. Every line of the
documentation comments contents must start with a # (see example
below).

OPTIONS

Array-i or --noindex

Don't generate index files.

-e or --noempty

Don't include empty modules.

-h, --help

Show summary of options.

-v, --version

Show version of program.

SEE ALSO

eric3(1), eric3-helpviewer(1), eric3-qregexp(1),

eric3-re(1), eric3-api(1), eric3-unittest(1).

AUTHOR

Arrayothers).
August 1, 2004

ERIC3-DOC(1)