Provided by: eric_4.5.18-1_all
eric4_doc - eric4 documentation generator
eric4_doc [options] files... where files can be be either Python modules, package directories or ordinary directories.
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).
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.
eric4(1), eric4_api(1), eric4_compare(1), eric4_configure(1), eric4_diff(1), eric4_editor(1), eric4_helpviewer(1), eric4_iconeditor(1), eric4_plugininstall(1), eric4_pluginrepository(1), eric4_pluginuninstall(1), eric4_qregexp(1), eric4_re(1), eric4_sqlbrowser(1), eric4_tray(1), eric4_trpreviewer(1), eric4_uipreviewer(1), eric4_unittest(1), eric4_webbrowser(1)
This manual page was written by Torsten Marek <email@example.com>, for the Debian project (but may be used by others). January 31, 2010 ERIC4_DOC(1)