gi-docgen
Documentation tool for GObject-based libraries
- Current
- 2025.5
- Candidate
- 2026.1
- License
- (Apache-2.0 OR GPL-3.0-or-later) AND CC0-1.0 AND MIT AND OFL-1.1
RuntimeDeps
| Dependency | Observed source | Current requirement | Candidate requirement |
|---|---|---|---|
3.1.6 | |||
3.10.2 | |||
3.0.2 | |||
25.0 | |||
2.20.0 | |||
tomliUnmapped | — | ||
2.1.0 | |||
3.14.9 |
Dependency conditions
- Applies when (any)
- python_version < "3.11"
Description
GI-DocGen is a document generator for GObject-based libraries. GObject is the base type system of the GNOME project. GI-Docgen reuses the introspection data generated by GObject-based libraries to generate the API reference of these libraries, as well as other ancillary documentation. GI-DocGen is not a general purpose documentation tool for C libraries. While GI-DocGen can be used to generate API references for most GObject/C libraries that expose introspection data, its main goal is to generate the reference for GTK and its immediate dependencies. Any and all attempts at making this tool more generic, or to cover more use cases, will be weighted heavily against its primary goal. GI-DocGen is still in development. The recommended use of GI-DocGen is to add it as a sub-project to your Meson build system, and vendor it when releasing dist archives. You should not depend on a system-wide installation until GI-DocGen is declared stable.
Changelog
PR · 2
Checks
| Monitor | Observation | Last checked |
|---|---|---|
Checked | ||
Checked | ||
Checked | ||
Checked | ||
Not configured No reliable monitor identity/configuration. | — | |
Checked Compared same-provider, same-project SPDX metadata for this version pair. | Last attempted | |
Checked | Last attempted | |
Checked Current source component only; local patches, build options, bundled dependencies and binary artifacts are not evaluated. | ||
Checked |