[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#987000: ITP: gi-docgen -- source code documentation tool using GObject-Introspection

Package: wnpp
Severity: wishlist
Owner: Simon McVittie <smcv@debian.org>
X-Debbugs-Cc: debian-devel@lists.debian.org, debian-gtk-gnome@lists.debian.org

* Package name    : gi-docgen
  Version         : 2021.2 or git snapshot
  Upstream Author : Emmanuele Bassi
* URL             : https://gitlab.gnome.org/GNOME/gi-docgen
* License         : Apache-2.0 OR GPL-3.0-or-later
  Programming Lang: Python
  Description     : 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

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.


We should probably package this in experimental even though
build-depending on it isn't useful yet, so that updates to to GTK-related
packages don't get stalled by the NEW queue or unforeseen packaging issues
when it's declared stable and stops being vendored by dependent packages.

Reply to: