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.
Update Information:
gi-docgen 2025.5 - 2025-10-11 This is a security fix for CVE-2025-11687. \u201cThe severity of this issue depends on what else is hosted on the same domain as the docs. XSS on a website that hosts only gi-docgen docs and nothing else is likely harmless.\u201d Fixed Make sure to escape query strings
* Sat Oct 11 2025 Benjamin A. Beasley - 2025.5-1
- Update to 2025.5 (close RHBZ#2403282)
* Fri Sep 19 2025 Python Maint
[ 1 ] Bug #2403282 - gi-docgen-2025.5 is available
https://bugzilla.redhat.com/show_bug.cgi?id=2403282
[ 2 ] Bug #2403540 - CVE-2025-11687 gi-docgen: Reflected DOM XSS in gi-docgen [fedora-42]
https://bugzilla.redhat.com/show_bug.cgi?id=2403540
This update can be installed with the "dnf" update program. Use su -c 'dnf upgrade --advisory FEDORA-2025-b4184a589e' at the command line. For more information, refer to the dnf documentation available at http://dnf.readthedocs.io/en/latest/command_ref.html#upgrade-command-label
Get the latest Linux and open source security news straight to your inbox.