Section: User Commands (1)Updated: January 31, 2010Local indexUp
NAME
eric4-doc - eric4 documentation generator
SYNOPSIS
eric4-doc
[options] files...
where files can be be either Python modules, package directories or ordinary directories.
DESCRIPTION
This manual page documents briefly the
eric4-doc
command.
This manual page was written for the Debian distribution
because the original program does not have a manual page.
Instead, it has documentation provided in the file /usr/share/doc/eric/README-eric4-doc.txt.gz in plain text format.
eric4-doc is the documentation generator of the eric4 IDE. Source code documentation may be included as ordinary Python doc-strings 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
These programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
For a complete description, see the Info files.
-p prefix or --prefix=prefix
Prepend given prefix to file names.
-o directory or --outdir=directory
Generate files in the named directory.
-R, -r or --recursive
Perform a recursive search for Python files.
-x directory or --exclude=directory
Specify a directory basename to be excluded.
This option may be repeated multiple times.