python-gi-docgen
Port variant v13
Summary Documentation tool for GObject-based libs (3.13)
Package version 2025.3
Homepage https://gitlab.gnome.org/GNOME/gi-docgen
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants v12
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 28 FEB 2025, 23:01:01 UTC
Port created 13 MAR 2021, 03:03:42 UTC
Subpackage Descriptions
set This is the python-gi-docgen:v13 metapackage. It pulls in all subpackages of python-gi-docgen:v13.
primary 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: - [HotDoc] - [Doxygen] - [GTK-Doc] ## 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.
dev This is the developer subpackage of the python-gi-docgen:v13 port. It may contain headers, pc files, static and PIC libraries and SO links.
Configuration Switches (platform-specific settings discarded)
PY312 OFF Build using Python 3.12 PY313 ON Build using Python 3.13
Package Dependencies by Type
Build (only) python313:dev:std
python-pip:single:v13
autoselect-python:single:std
Build and Runtime python313:primary:std
Runtime (only) python-Markdown:single:v13
python-MarkupSafe:single:v13
python-Pygments:single:v13
python-Jinja2:single:v13
python-packaging:single:v13
python-typogrify:single:v13
Download groups
main mirror://PYPIWHL/46/cd/d5e85c225e9cdf48bbdc0aab13e3c866f03edb802f940d382c129ec65819
Distribution File Information
c26a276ff0979ef0166a9f8a23a7c9a5527f49df25bce14850d6c76fec604ce2 1264294 python-src/gi_docgen-2025.3-py2.py3-none-any.whl
Ports that require python-gi-docgen:v13
No other ports depend on this one.