DOQ(1)

🦋 DOQ(1) — the doq manual, bestie 🦋

okay so welcome to DOQ(1), the manual page for doq — yes, the docstring generator. It's giving utility, it's giving main character energy, and we're gonna walk through every single flag together. no cap. 💅

---

✨ NAME ✨

doq — Docstring generator. 💖

---

🌸 SYNOPSIS 🌸

Here's the exact command shape, bestie — copy/paste energy:

doq [-h] [--print-completion {bash,zsh,tcsh}] [-f FILE] [--start START]
    [--end END] [-t TEMPLATE_PATH] [-s STYLE] [--formatter FORMATTER]
    [--indent INDENT] [--omit OMIT] [-r] [-d DIRECTORY] [-w] [-v]
    [-c CONFIG] [--ignore_exception] [--ignore_yield] [--ignore_init]

---

💖 DESCRIPTION 💖

Docstring generator. That's the whole vibe — doq generates docstrings, and this page is literally the map of all its options. slay. 🎀

---

🎀 OPTIONS 🎀

• -h, --help — show this help message and exit. the classic "help me help you" moment. 🫶
• --print-completion {bash,zsh,tcsh} — print shell completion script. literally spell it out for your shell: bash, zsh, or tcsh. ✨
• -f, --file FILE — File or STDIN. give it a file, or feed it through standard input. 💌
• --start START — Start lineno. tell it where the party starts. 🌸
• --end END — End lineno. tell it where the party stops. 🦋
• -t, --template_path TEMPLATE_PATH — Path to template directory. the template folder is right this way, bestie. 🎀
• -s, --style STYLE — Output style string or json. pick your aesthetic. 💅
• --formatter FORMATTER — Docstring formatter: sphinx,google or numpy. choose your formatter era. 👑
• --indent INDENT — Indent number. how much space are we giving things? 🌈
• --omit OMIT — Omit first argument such as self. sometimes self does not need to be in the group chat. 🙈
• -r, --recursive — Run recursively over directories. it goes deep. 🔥
• -d, --directory DIRECTORY — Path to directory. point it at the folder of your dreams. 🍓
• -w, --write — Edit files in-place. yes, it's gonna touch the files directly — be normal about it. 💀
• -v, --version — Output the version number. version check, periodt. ⭐
• -c, --config CONFIG — Path to a setup.cfg or pyproject.toml. config file behavior, iykyk. 💜
• --ignore_exception — Ignore exception statements. not today, exceptions. 😭
• --ignore_yield — Ignore yield statements. yield? never heard of her. 🧚
• --ignore_init — Ignore generate docstring to __init__ method. the __init__ method gets a lil exemption. ✨

---

This iconic page is from doq version 0.10.0, dated 2026-10-25, and it's the DOQ(1) manual — mwah 💋✨