---
name: "eric3-doc"
section: "1"
platform: "linux"
package: "eric"
version: "3.9.1-1"
release: "Debian 4.0 (Etch)"
platforms: ["linux"]
url: "https://new.carta.tech/eric3-doc"
---

# eric3-doc(1)

eric3 documentation generator

@ -0,0 +1,77 @@

## 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

This manual page documents briefly the **eric3-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/eric3/README-eric3-doc.txt.gz in plain text format.

**eric3-doc** is the documentation generator of the eric3 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

[**eric3**(1)](/eric3/1.md), [**eric3-helpviewer**(1)](/eric3-helpviewer/1.md), [**eric3-qregexp**(1)](/eric3-qregexp/1.md), [**eric3-re**(1)](/eric3-re/1.md), [**eric3-api**(1)](/eric3-api/1.md), [**eric3-unittest**(1)](/eric3-unittest/1.md).\

## AUTHOR

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