g-ir-doc-tool(1)

Usage

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

Overview

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

--help: Show help options

--output=DIRECTORY: Save the resulting output in DIRECTORY.

--format=FORMAT: Output format. One of devdocs, mallard or sections.

--language=LANGUAGE: Output language. One of c, python, or gjs.

--add-include-path=DIRECTORY: Adds a directory which will be used to find includes inside the GIR format.

--version: Show program's version number and exit

--write-sections-file: Backwards-compatible equivalent to -f sections.

Homepage and contact

https://gi.readthedocs.io/

Releases

Unchanged in 3 releases since Debian 12 (Bookworm).

12–Arch