G-IR-DOC-TOOL(1) G-IR-DOC-TOOL(1)

# [NAME](#NAME)

g-ir-doc-tool - Documentation builder

# [SYNOPSIS](#SYNOPSIS)

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

# [DESCRIPTION](#DESCRIPTION)

g-ir-doc-tool builds library documentation directly from .gir files. The output is adjusted according to which programming language you're generating docs for.

# [OPTIONS](#OPTIONS)

[**--help**](#help)

Show help options

[**--output=**DIRECTORY****](#output)

Save the resulting output in DIRECTORY.

[**--format=**FORMAT****](#format)

Output format. One of devdocs, mallard or sections.

[**--language=**LANGUAGE****](#language)

Output language. One of c, python, or gjs.

[**--add-include-path=**DIRECTORY****](#add)

Adds a directory which will be used to find includes inside the GIR format.

[**--version**](#version)

Show program's version number and exit

[**--write-sections-file**](#write)

Backwards-compatible equivalent to -f sections.

# [BUGS](#BUGS)

Report bugs at *https://gitlab.gnome.org/GNOME/gobject-introspection/issues*

# [HOMEPAGE AND CONTACT](#HOMEPAGE_AND_CONTACT)

*https://gi.readthedocs.io/*

# [AUTHORS](#AUTHORS)

David King

---

Document: g-ir-doc-tool(1) from gobject-introspection 1.86.0-r4 (Chainguard OS)
Source: https://gitlab.gnome.org/GNOME/gobject-introspection