Man page - eric7_doc(1)
Packages contains this manual
- eric7_plugininstall(1)
- eric7_pluginrepository(1)
- eric7_shell(1)
- eric7_virtualenv(1)
- eric7_trpreviewer(1)
- eric7_api(1)
- eric7_sqlbrowser(1)
- eric7_uipreviewer(1)
- eric7_iconeditor(1)
- eric7_qregularexpression(1)
- eric7_pluginuninstall(1)
- eric7_configure(1)
- eric(1)
- eric7_tray(1)
- eric7_browser(1)
- eric7_doc(1)
- eric7_editor(1)
- eric7_diff(1)
- eric7_pip(1)
- eric7_pdf(1)
- eric7_hexeditor(1)
- eric7_ide(1)
- eric7_compare(1)
- eric7_testing(1)
- eric7_re(1)
- eric7_snap(1)
apt-get install eric
Manual
ERIC7_DOC
NAMESYNOPSIS
DESCRIPTION
OPTIONS
SEE ALSO
AUTHOR
AUTHOR
NAME
eric7_doc - eric7 documentation generator
SYNOPSIS
eric7_doc [ options ] files ...
where files can be be either Python modules, package directories or ordinary directories.
DESCRIPTION
This manual page documents briefly the eric7_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-eric7-doc.txt.gz in plain text format.
eric7_doc is the documentation generator of the eric7 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.
-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
eric7_ide (1), eric7_api (1), eric7_browser (1), eric7_compare (1), eric7_configure (1), eric7_diff (1), eric7_doc (1), eric7_editor (1), eric7_hexeditor (1), eric7_iconeditor (1), eric7_pdf (1), eric7_pip (1), eric7_plugininstall (1), eric7_pluginrepository (1), eric7_pluginuninstall (1), eric7_qregularexpression (1), eric7_re (1), eric7_shell (1), eric7_snap (1), eric7_sqlbrowser (1), eric7_testing (1), eric7_tray (1), eric7_trpreviewer (1), eric7_uipreviewer (1), eric7_virtualenv (1),
AUTHOR
eric7_doc was written by Detlev Offenbach.
AUTHOR
This manual page was written by Torsten Marek <shlomme@gmx.net>, for the Debian project (but may be used by others).