G-IR-DOC-TOOL(1)

✨ NAME ✨

g-ir-doc-tool — bestie, it's literally a documentation builder 💅

🌸 SYNOPSIS 🌸

g-ir-doc-tool [OPTION...] GIRFILE

🦋 DESCRIPTION 🦋

okay so listen. g-ir-doc-tool builds library documentation straight from .gir files. no middleman, no drama, no cap. 📚✨

and here's the cute part — the output gets adjusted depending on which programming language you're generating docs for. it's giving tailored. it's giving custom fit. it knows what it's doing and honestly? obsessed. 🫶

💖 OPTIONS 💖

• --help — shows you the help options. classic. when in doubt, ask for help, bestie 🙈
• --output=DIRECTORY — saves the resulting output in DIRECTORY. that's where your docs go to live their best life 🏡
• --format=FORMAT — the output format. one of devdocs, mallard or sections. pick your fighter ⭐
• --language=LANGUAGE — the output language. one of c, python, or gjs. three icons, zero wrong answers 👑
• --add-include-path=DIRECTORY — adds a directory that will be used to find includes inside the GIR format. it's like giving your tool a lil map so it stops getting lost 🗺️
• --version — shows the program's version number and exits. quick peek, then bye ✌️
• --write-sections-file — a backwards-compatible equivalent to -f sections. the og vibe, still valid 💜

heads up, the description line for --write-sections-file mentions -f sections, and that's just how it is — not me renaming anything, fr fr.

😭 BUGS 😭

found a bug? don't suffer in silence, bestie. report it at:

https://gitlab.gnome.org/GNOME/gobject-introspection/issues

they want to know. it's giving community. it's giving we-fix-it-together 🌈

🎀 HOMEPAGE AND CONTACT 🎀

https://gi.readthedocs.io/

go say hi. the homepage is right there waiting for you 💖

💅 AUTHORS 💅

David King — the icon, the moment, the author 💜

okay that's the whole page!! this manual page is G-IR-DOC-TOOL(1), so that's the source/version vibe and the date vibe — it's the G-IR-DOC-TOOL(1) page, periodt. mwah, go build some docs, you absolute legend 🧚✨🌸