1G-IR-DOC-TOOL(1)                                              G-IR-DOC-TOOL(1)
2
3
4

NAME

6       g-ir-doc-tool - Documentation builder
7

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

17       --help Show help options
18
19       --output=DIRECTORY
20              Save the resulting output in DIRECTORY.
21
22       --format=FORMAT
23              Output format. One of devdocs, mallard or sections.
24
25       --language=LANGUAGE
26              Output language. One of c, python, or gjs.
27
28       --add-include-path=DIRECTORY
29              Adds  a directory which will be used to find includes inside the
30              GIR format.
31
32       --version
33              Show program's version number and exit
34
35       --write-sections-file
36              Backwards-compatible equivalent to -f sections.
37

BUGS

39       Report                             bugs                              at
40       https://gitlab.gnome.org/GNOME/gobject-introspection/issues
41

HOMEPAGE AND CONTACT

43       https://gi.readthedocs.io/
44

AUTHORS

46       David King
47
48
49
50
51                                                              G-IR-DOC-TOOL(1)
Impressum