How To Install gi-docgen on Debian 12

Learn how to install gi-docgen on Debian 12 with this tutorial. gi-docgen is source code documentation tool using GObject-Introspection

Introduction

In this tutorial we learn how to install gi-docgen on Debian 12.

What is gi-docgen

gi-docgen is:

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.

There are three methods to install gi-docgen on Debian 12. We can use apt-get, apt and aptitude. In the following sections we will describe each method. You can choose one of them.

Install gi-docgen Using apt-get

Update apt database with apt-get using the following command.

sudo apt-get update

After updating apt database, We can install gi-docgen using apt-get by running the following command:

sudo apt-get -y install gi-docgen

Install gi-docgen Using apt

Update apt database with apt using the following command.

sudo apt update

After updating apt database, We can install gi-docgen using apt by running the following command:

sudo apt -y install gi-docgen

Install gi-docgen Using aptitude

If you want to follow this method, you might need to install aptitude first since aptitude is usually not installed by default on Debian. Update apt database with aptitude using the following command.

sudo aptitude update

After updating apt database, We can install gi-docgen using aptitude by running the following command:

sudo aptitude -y install gi-docgen

How To Uninstall gi-docgen on Debian 12

To uninstall only the gi-docgen package we can use the following command:

sudo apt-get remove gi-docgen

Uninstall gi-docgen And Its Dependencies

To uninstall gi-docgen and its dependencies that are no longer needed by Debian 12, we can use the command below:

sudo apt-get -y autoremove gi-docgen

Remove gi-docgen Configurations and Data

To remove gi-docgen configuration and data from Debian 12 we can use the following command:

sudo apt-get -y purge gi-docgen

Remove gi-docgen configuration, data, and all of its dependencies

We can use the following command to remove gi-docgen configurations, data and all of its dependencies, we can use the following command:

sudo apt-get -y autoremove --purge gi-docgen

Dependencies

gi-docgen have the following dependencies:

References

Summary

In this tutorial we learn how to install gi-docgen package on Debian 12 using different package management tools: apt, apt-get and aptitude.