ERIC7_DOC(1)

💖 ERIC7_DOC(1) — the eric7 documentation generator, bestie edition 💖

okay so you found the manual page for eric7_doc, part of the General Commands Manual section (that's section 1, iykyk). sit down, grab a lil snack 🍓, and let's get you fluent.

---

✨ NAME ✨

eric7_doc — the eric7 documentation generator. that's it, that's the whole name section, she's lowkey self-explanatory 💅

---

🌸 SYNOPSIS 🌸

eric7_doc [options] files...

where files can be either Python modules, package directories or ordinary directories. yes bestie, all three, she's flexible like that 🦋

---

🎀 DESCRIPTION 🎀

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. so if you want the long version, that gzipped lil guy is right there 🫶

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 — that's not a choice, that's just how Quixote works internally, no cap 😭

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). every single line, bestie, don't skip one or she'll be confused 🙈

fr fr: ### opens it, ### closes it, and every line in between starts with #. that's the whole recipe.

---

💅 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, --prefix=prefix — prepend the given prefix to file names.
• -o directory, --outdir=directory — generate files in the named directory. that's where the magic lands ✨
• -R, -r, --recursive — perform a recursive search for Python files. three whole ways to say "go deep" 🔥
• -x directory, --exclude=directory — specify a directory basename to be excluded. This option may be repeated multiple times. so stack it as many times as you need, she doesn't mind 💜
• -i, --noindex — don't generate index files.
• -e, --noempty — don't include empty modules.
• -h, --help — show summary of options.
• -v, --version — show version of program.

---

🌈 SEE ALSO 🌈

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_fido2.1(1), eric7_hexeditor(1), eric7_iconeditor(1), eric7_mpy(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)

(yes, eric7_doc(1) is in her own SEE ALSO list. she's her own reference, main character energy 👑)

---

👑 AUTHOR 👑

eric7_doc was written by Detlev Offenbach.

💖 AUTHOR (the sequel) 💖

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

---

and that's the whole page, bestie — you ate it, periodt. 💅

this lil writeup is from the eric7_doc manual page, dated January 31, 2010 — so yeah, she's vintage and still serving 🦋