1.. SPDX-FileCopyrightText: 2021 GNOME Foundation 2.. 3.. SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later 4 5======== 6Commands 7======== 8 9.. toctree:: 10 :hidden: 11 :titlesonly: 12 :maxdepth: 1 13 14 generate 15 gen-index 16 17SYNOPSIS 18======== 19 20**gi-docgen** COMMAND [OPTIONS...] 21 22The ``gi-docgen`` command line utility has several commands, each with its 23own functionality and options. 24 25COMMANDS 26======== 27 28:doc:`generate` 29 Generates the API reference 30 31:doc:`gen-index` 32 Generates the symbol indices for search 33 34OPTIONS 35======= 36 37All commands support the following options: 38 39``-q, --quiet`` 40 Do not emit any additional information message. 41 42``--fatal-warnings`` 43 Make all warnings fatal, immediately terminating the process. 44 45``--help`` 46 Show an help message. 47 48ENVIRONMENT VARIABLES 49===================== 50 51All commands support the following environment variables: 52 53``GIDOCGEN_DEBUG`` 54 If set, ``gi-docgen`` will emit debugging messages. 55 56 57BUGS 58==== 59 60Report bugs at https://gitlab.gnome.org/GNOME/gi-docgen/issues 61 62HOMEPAGE and CONTACT 63==================== 64 65https://gnome.pages.gitlab.gnome.org/gi-docgen/ 66 67AUTHOR 68====== 69 70Emmanuele Bassi 71