TYPER-UTILS-DOCS(1)

💖 TYPER-UTILS-DOCS 💖

okay bestie, so this is typer-utils-docs — it's the little glow-up machine that generates Markdown docs for a Typer app ✨ that's literally the whole job and it ate 💅

It lives in the User Commands corner of your manual, and the manual name is TYPER-UTILS-DOCS(1), iykyk 🎀

---

🌸 SYNOPSIS 🌸

typer [PATH_OR_MODULE] utils docs [OPTIONS]

so you point it at a PATH_OR_MODULE, say the magic word utils docs, and it starts spitting out docs. main character energy fr fr 🦋

✨ OPTIONS ✨

• --name TEXT — the name of the CLI program to use in the docs. that's the name that shows up when people read about your app 💖
• --output FILE — an output file to write the docs to, like README.md. [default: None] 📝 (so if you don't say anything, it defaults to None — no file, no cap)
• --title TEXT — the title for the documentation page. If not provided, the name of the program is used. [default: None] 👑 so like, skip it and it'll just borrow the program name, slay
• --help — Show a help message and exit. the classic escape hatch 🙈

ngl, that's the entire option list. short, sweet, iconic. periodt 💅

---

🔥 SEE ALSO 🔥

• typer-utils(1)
• typer(1)

go read those too, bestie, they're the supporting cast 🌈

---

mwah 💋 that's a wrap! this page is from April 2024, and the source/version line is the TYPER-UTILS-DOCS(1) manual from User Commands 🫶 stay hydrated, write docs, and don't forget to exit 0 🌸💖✨