OnWorks favicon

eric6_doc - Online in the Cloud

Run eric6_doc in OnWorks free hosting provider over Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

This is the command eric6_doc that can be run in the OnWorks free hosting provider using one of our multiple free online workstations such as Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator



eric5_doc - eric5 documentation generator


eric5_doc [options] files...

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


This manual page documents briefly the eric5_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-eric5-doc.txt.gz in plain text format.

eric5_doc is the documentation generator of the eric5 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

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

Use eric6_doc online using onworks.net services

Free Servers & Workstations

Download Windows & Linux apps

  • 1
    Avogadro is an advanced molecular
    editor designed for cross-platform use
    in computational chemistry, molecular
    modeling, bioinformatics, materials
    science and ...
    Download Avogadro
  • 2
    XMLTV is a set of programs to process
    TV (tvguide) listings and help manage
    your TV viewing, storing listings in an
    XML-based format. There are utilities to
    Download XMLTV
  • 3
    Strikr Free Software project. Artifacts
    released under a 'intent based'
    dual license: AGPLv3 (community) and
    CC-BY-NC-ND 4.0 international
    Download strikr
  • 5
    giflib is a library for reading and
    writing gif images. It is API and ABI
    compatible with libungif which was in
    wide use while the LZW compression
    algorithm was...
    Download GIFLIB
  • 6
    With Hugin you can assemble a mosaic of
    photographs into a complete immersive
    panorama, stitch any series of
    overlapping pictures and much more..
    Audience: Sci...
    Download Hugin
  • 7
    Alt-F provides a free and open source
    alternative firmware for the DLINK
    DNS-320/320L/321/323/325/327L and
    DNR-322L. Alt-F has Samba and NFS;
    supports ext2/3/4...
    Download Alt-F
  • More »

Linux commands