ERIC6_DOC(1)

📦 version 21.1, in ubuntu jammy

💖 ERIC6_DOC — the eric6 documentation generator, but make it make sense 💖

okay bestie, so this is the manual page for eric6_doc(1), which lives in the General Commands Manual section. she's a little niche, she's a little iconic, and she generates documentation. let's get into it ✨

🌸 NAME 🌸

eric6_doc — the eric6 documentation generator. that's it. that's the whole name section. she's concise, she's confident, we love her 🫶

🎀 SYNOPSIS 🎀

eric6_doc [options] files...

and the files situation? lowkey flexible. they can be Python modules, package directories, or just regular ordinary directories. whatever you're holding, she'll take it 💅

🦋 DESCRIPTION 🦋

So real talk — this manual page is a little "briefly documents the eric6_doc command" situation. It was written for the Debian distribution specifically, because the original program straight up does not have a manual page. not a vibe of theirs, apparently. instead, the actual documentation lives at:

/usr/share/doc/eric/README-eric6-doc.txt.gz

and it's in plain text format. cute, compressed, on brand 💖

eric6_doc is the documentation generator of the eric6 IDE. main character energy, truly.

Now, the way you feed her documentation — she accepts it in two flavors:

  • ordinary Python doc-strings, or
  • documentation comments
⚠️ okay but here's the tea for Quixote Template file (PTL): you get documentation comments only. no doc-strings. and it's not personal, it's just the inner workings of Quixote being Quixote. that's the whole reason, no cap 😭

So what does a documentation comment even look like? Bestie, get this:

  • it starts with the string ###
  • then the contents come next
  • and it ends with ###

And — important, don't skip this — every single line of the documentation comments contents must start with a #. every. one. (see example below, they said, and we respect them for it 🧚)

✨ OPTIONS ✨

okay so 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. let's run the list, no skips:

  • -p prefix, --prefix=prefix — prepend the given prefix to file names. a little name glow-up ✨
  • -o directory, --outdir=directory — generate the files in the named directory. put them somewhere nice.
  • -R, -r, --recursive — do a recursive search for Python files. she will go deep, fr fr 🌀
  • -x directory, --exclude=directory — specify a directory basename to be excluded. and guess what — this option may be repeated multiple times. stack 'em. exclude everything that isn't serving 🚫
  • -i, --noindex — don't generate index files. no index, no problem.
  • -e, --noempty — don't include empty modules. if it's giving nothing, it's not invited 💀
  • -h, --help — show summary of options. your girl is helpful, always.
  • -v, --version — show version of program. check the era you're in 💅

💜 SEE ALSO 💜

the whole friend group, in order, as listed:

the squad. the roster. we stan an entire ecosystem 🌈

👑 AUTHOR 👑

this manual page was written by Torsten Marek <shlomme@gmx.net>, for the Debian project (but may be used by others). shoutout to Torsten for the lore, absolute icon 🫶

and that's the whole page, bestie!! this version of eric6_doc(1) came from the General Commands Manual, dated January 31, 2010 — yes she's an elder, yes she still slays. mwah 💖✨🎀🦋🌸💅

📦 where this page comes from