Skip to content
Sections
>> Trisquel >> Packages >> aramo >> gnome >> gi-docgen
[  aramo  ]
[ Source: gi-docgen  ]

Package: gi-docgen (2022.1+ds-1)

source code documentation tool using GObject-Introspection

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.

GI-DocGen is still in development. The upstream-recommended use of GI-DocGen is to add it as a sub-project to a Meson build system, and vendor it when releasing dist archives. Until GI-DocGen becomes stable, Debian packages that use it for their documentation should use a vendored copy (as allowed by Policy §4.13), and should not have a Build-Depends on gi-docgen unless no vendored copy is present in upstream releases.

Other Packages Related to gi-docgen

  • depends
  • recommends
  • suggests
  • dep: python3
    interactive high-level object-oriented language (default python3 version)
  • dep: python3-jinja2
    small but fast and easy to use stand-alone template engine
  • dep: python3-markdown
    text-to-HTML conversion library/tool (Python 3 version)
  • dep: python3-markupsafe
    HTML/XHTML/XML string library
  • dep: python3-pygments
    syntax highlighting package written in Python 3
  • dep: python3-toml
    library for Tom's Obvious, Minimal Language - Python 3.x
  • dep: python3-typogrify
    filters to transform text into typographically-improved HTML (Python 3)

Download gi-docgen

Download for all available architectures
Architecture Package Size Installed Size Files
all 82.0 kB622 kB [list of files]