python-gi-docgen
Port variant py39
Summary Documentation tool for GObject-based libs (3.9)
Package version 2022.1
Homepage https://gitlab.gnome.org/GNOME/gi-docgen
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants py310
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 15 APR 2022, 22:13:15 UTC
Port created 12 MAR 2021, 03:03:42 UTC
Subpackage Descriptions
single 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.
Configuration Switches (platform-specific settings discarded)
PY310 OFF Build using Python 3.10 PY39 ON Build using Python 3.9
Package Dependencies by Type
Build (only) python-pip:single:py39
autoselect-python:single:standard
Build and Runtime python39:single:standard
Runtime (only) python-Markdown:single:py39
python-MarkupSafe:single:py39
python-Pygments:single:py39
python-Jinja2:single:py39
python-toml:single:py39
python-typogrify:single:py39
Download groups
main mirror://PYPIWHL/c1/53/aa5175b30b36e0095caeb2ea89a677d6aca9df1836b528df1682ca02fd98
Distribution File Information
25a13fcbe0e644e9738d583e0014b7819c5a8cecfba63d399a294a07ce290531 1254238 gi_docgen-2022.1-py2.py3-none-any.whl
Ports that require python-gi-docgen:py39
libpeas:py310 GObject-based plugins engine (3.10)
libpeas:py39 GObject-based plugins engine (3.9)
librsvg:standard SVG vector-graphic files rendering library