Scroll to navigation

ERIC7_DOC(1) General Commands Manual ERIC7_DOC(1)


eric7_doc - eric7 documentation generator


eric7_doc [options] files...

where files can be be either Python modules, package directories or ordinary directories.


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).


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.

Prepend given prefix to file names.
Generate files in the named directory.
Perform a recursive search for Python files.
Specify a directory basename to be excluded. This option may be repeated multiple times.
Don't generate index files.
Don't include empty modules.
Show summary of options.
Show version of program.


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),


eric7_doc was written by Detlev Offenbach.


This manual page was written by Torsten Marek <>, for the Debian project (but may be used by others).

January 31, 2010