Skip to main content

Documentation tool for GObject-based libraries

Project description

GI-DocGen: Documentation tool for GObject-based libraries

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.

Installation

Running GI-DocGen uninstalled

You can run GI-DocGen from its repository, by calling:

./gi-docgen.py

GI-DocGen will automatically detect this case.

Installing GI-DocGen via pip

To install GI-DocGen, you will need to have the following pieces of software available on your computer:

  • Python 3.6, or later
  • pip

Run the following command:

pip3 install --user gi-docgen

After running the command above, make sure to have the ~/.local/bin directory listed in your $PATH environment variable.

To update GI-DocGen, run the following command:

pip3 install --user --upgrade gi-docgen

Usage

First, read the GI-DocGen tutorial.

The documentation for GI-DocGen is available online.

The examples directory in the repository contains simple project files for various GNOME libraries.

Disclaimer

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.

If you need a general purpose documentation tool, I strongly recommend:

Copyright and Licensing terms

Copyright 2021 GNOME Foundation

GI-DocGen is released under the terms of the Apache License, version 2.0, or under the terms of the GNU General Public License, either version 3.0 or, at your option, any later version.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gi_docgen-2025.4.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

gi_docgen-2025.4-py2.py3-none-any.whl (1.3 MB view details)

Uploaded Python 2Python 3

File details

Details for the file gi_docgen-2025.4.tar.gz.

File metadata

  • Download URL: gi_docgen-2025.4.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for gi_docgen-2025.4.tar.gz
Algorithm Hash digest
SHA256 7fe066da082a4edcf924063767404f9d04a998f6c0f0c475b180fd9823a72dc5
MD5 c10dc911cb1f802cebf8f139f7598cf7
BLAKE2b-256 4903b3202f4ae48f70db6c90402adf3350a8931034099ac6a006c5695d5e4740

See more details on using hashes here.

File details

Details for the file gi_docgen-2025.4-py2.py3-none-any.whl.

File metadata

  • Download URL: gi_docgen-2025.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for gi_docgen-2025.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6e1e81c47be31de79f074be5b6a863d08920dd0871ca057a65ffb1f9590a50e4
MD5 a22ad6690bd3c90f7df988964385627d
BLAKE2b-256 48f508e6a111002047f2dbd2125e8546467c2ebd86a8095650fde5643bf28f14

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page