LIMNORIA-PLUGIN-DOC(1)

💖 LIMNORIA-PLUGIN-DOC 💖

okay bestie, so you're in the General Commands Manual section, and this lil cutie is called limnoria-plugin-doc. she's the one who writes the docs for your Limnoria plugins, no cap. let's get into it ✨

✨ NAME ✨

limnoria-plugin-doc — generates the documentation for a Limnoria plugin 🎀

🌸 SYNOPSIS 🌸

limnoria-plugin-doc [options]

🦋 DESCRIPTION 🦋

so basically, limnoria-plugin-doc is the tool you use to generate documentation for a limnoria(1) plugin. and not just any docs — she does it in StructuredText or reStructuredText format. literally the plug for making your plugin look put-together. periodt 💅

👑 OPTIONS 👑

• --version — shows you the version of the program. slay, now you know what you're working with.
• -h, --help — shows a summary of the options. your little cheat sheet, bestie 🫶
• -c, --clean — cleans the various data/conf/log directories after generating the docs. so it's like, generate first, tidy up after. she's a clean girl, she's organized ✨
• -o, --output-dir=OUTPUTDIR — tells her which directory to write the plugin's documentation into. OUTPUTDIR is your call, bestie — pick a spot 💖
• -f, --format=FORMAT — picks which output format to use. the choices are rst or stx. that's it, those are the two, don't try to get creative 😭
• --plugins-dir=PLUGINSDIRS — she looks in the directory you give her for plugins, and then generates documentation for all of them. like, every single one. bulk mode. iconic behavior 👑

🔥 SEE ALSO 🔥

python(1), limnoria(1), limnoria-test(1), limnoria-botchk(1), limnoria-wizard(1), limnoria-adduser(1), limnoria-plugin-create(1)

💜 AUTHOR 💜

this manual page was originally written by James McCoy <vega dot james at gmail dot com>. and permission is granted to copy, distribute and/or modify this document under the terms of the Limnoria license, which is a BSD-style license. so yes bestie, you can remix it, just keep it cute and keep the license 🌈

okay so quick vibe check before you go: this page is dated May 2009, and it comes from the source/version tagged as LIMNORIA-PLUGIN-DOC(1). that's the whole lore. go generate some docs, you got this 🦋💖