GI-DOCGEN(1) | User Commands | GI-DOCGEN(1) |
gi-docgen - a documentation generator using gobject-introspection
gi-docgen COMMAND [OPTION...] GIR_FILE
GI-DocGen is a document generator for GObject-based libraries. GObject is the base type system of the GNOME project. GI-DocGen uses the machine readable introspection data provided by GObject-based libraries in order to generate the API reference of these libraries, as well as other ancillary documentation.
The main gi-docgen executable provides various subcommands to access all its functionality.
All commands have the following options:
The generate command provides the main functionality of gi-docgen.
gi-docgen generate [ OPTIONS ] [ GIR_FILE ]
The generate command will parse the given GIR file, as well as its dependencies, and build an API reference for the namespace it finds in the introspection data. Projects can use a configuration file to control aspects of the output, as well as provide additional content that should be included in the documentation.
The gen-index command generates an index of symbols and terms that can be used to search inside the documentation generated by gi-docgen.
gi-docgen gen-index [ OPTIONS ] [ GIR_FILE ]
The generated index is a JSON formatted file is called index.json.
The check command runs a series of checks on the introspection file, to verify that public API is properly documented. It can be used as part of a test suite.
gi-docgen check [ OPTIONS ] [ GIR_FILE ]
The serve command generates an API reference and serves it using a local HTTP server.
gi-docgen serve [ OPTIONS ] [ GIR_FILE ]
The serve command will parse the given GIR file, as well as its dependencies, and build an API reference for the namespace it finds in the introspection data. Once the reference has been built successfully, gi-docgen will start a local HTTP server pointing at the output directory.
The help command prints out the command line help. If you don't specify any command or option when invoking gi-docgen, the help command will be implied.
gi-docgen help [ OPTIONS ] [ COMMAND ]
If no command is specified, help will print out the list of commands.
If a command is specified, help will print out the command line help for that program.
The gi-docgen executable uses the XDG_DATA_DIRS and XDG_DATA_HOME environment variables to search for introspection data included in the GIR file.
If the GIDOCGEN_DEBUG environment variable is set, gi-docgen will print out additional messages, which can be helpful when debugging issues.
GI-DocGen: http://gnome.pages.gitlab.gnome.org/gi-docgen/
GObject-Introspection: https://gi.readthedocs.org/
GObject: https://developer.gnome.org/gobject/
gi-docgen 2021.3 |