How To Install gi-docgen on Fedora 36
Introduction
In this tutorial we learn how to install gi-docgen
on Fedora 36.
What is gi-docgen
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. 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.
We can use yum
or dnf
to install gi-docgen
on Fedora 36. In this tutorial we discuss both methods but you only need to choose one of method to install gi-docgen.
Install gi-docgen on Fedora 36 Using dnf
Update yum database with dnf
using the following command.
sudo dnf makecache --refresh
After updating yum database, We can install gi-docgen
using dnf
by running the following command:
sudo dnf -y install gi-docgen
Install gi-docgen on Fedora 36 Using yum
Update yum database with yum
using the following command.
sudo yum makecache --refresh
After updating yum database, We can install gi-docgen
using yum
by running the following command:
sudo yum -y install gi-docgen
How To Uninstall gi-docgen on Fedora 36
To uninstall only the gi-docgen
package we can use the following command:
sudo dnf remove gi-docgen
gi-docgen Package Contents on Fedora 36
/usr/bin/gi-docgen
/usr/lib/python3.10/site-packages/gi_docgen-2022.1.dist-info
/usr/lib/python3.10/site-packages/gi_docgen-2022.1.dist-info/Apache-2.0.txt
/usr/lib/python3.10/site-packages/gi_docgen-2022.1.dist-info/GPL-3.0-or-later.txt
/usr/lib/python3.10/site-packages/gi_docgen-2022.1.dist-info/INSTALLER
/usr/lib/python3.10/site-packages/gi_docgen-2022.1.dist-info/METADATA
/usr/lib/python3.10/site-packages/gi_docgen-2022.1.dist-info/WHEEL
/usr/lib/python3.10/site-packages/gi_docgen-2022.1.dist-info/entry_points.txt
/usr/lib/python3.10/site-packages/gi_docgen-2022.1.dist-info/top_level.txt
/usr/lib/python3.10/site-packages/gidocgen
/usr/lib/python3.10/site-packages/gidocgen/__init__.py
/usr/lib/python3.10/site-packages/gidocgen/__pycache__
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/__init__.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/__init__.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/config.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/config.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/core.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/core.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdcheck.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdcheck.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdgendeps.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdgendeps.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdgenerate.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdgenerate.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdgenindices.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdgenindices.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdindex.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdindex.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdsearch.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gdsearch.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gidocmain.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/gidocmain.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/log.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/log.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/mdext.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/mdext.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/porter.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/porter.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/utils.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/__pycache__/utils.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/config.py
/usr/lib/python3.10/site-packages/gidocgen/core.py
/usr/lib/python3.10/site-packages/gidocgen/gdcheck.py
/usr/lib/python3.10/site-packages/gidocgen/gdgendeps.py
/usr/lib/python3.10/site-packages/gidocgen/gdgenerate.py
/usr/lib/python3.10/site-packages/gidocgen/gdgenindices.py
/usr/lib/python3.10/site-packages/gidocgen/gdindex.py
/usr/lib/python3.10/site-packages/gidocgen/gdsearch.py
/usr/lib/python3.10/site-packages/gidocgen/gidocmain.py
/usr/lib/python3.10/site-packages/gidocgen/gir
/usr/lib/python3.10/site-packages/gidocgen/gir/__init__.py
/usr/lib/python3.10/site-packages/gidocgen/gir/__pycache__
/usr/lib/python3.10/site-packages/gidocgen/gir/__pycache__/__init__.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/gir/__pycache__/__init__.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/gir/__pycache__/ast.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/gir/__pycache__/ast.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/gir/__pycache__/parser.cpython-310.opt-1.pyc
/usr/lib/python3.10/site-packages/gidocgen/gir/__pycache__/parser.cpython-310.pyc
/usr/lib/python3.10/site-packages/gidocgen/gir/ast.py
/usr/lib/python3.10/site-packages/gidocgen/gir/parser.py
/usr/lib/python3.10/site-packages/gidocgen/log.py
/usr/lib/python3.10/site-packages/gidocgen/mdext.py
/usr/lib/python3.10/site-packages/gidocgen/porter.py
/usr/lib/python3.10/site-packages/gidocgen/templates
/usr/lib/python3.10/site-packages/gidocgen/templates/basic
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/base.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/basic.toml
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/class.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/class_method.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/constant.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/content.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/ctor.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/enum.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/fonts.css
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/function.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/fzy.js
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/go-up-symbolic.png
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/interface.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/main.js
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/method.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/namespace.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/property.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/search.js
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/signal.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/solarized-dark.css
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/solarized-light.css
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/struct.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/style.css
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/type_func.html
/usr/lib/python3.10/site-packages/gidocgen/templates/basic/vfunc.html
/usr/lib/python3.10/site-packages/gidocgen/utils.py
/usr/share/licenses/gi-docgen
/usr/share/licenses/gi-docgen/Apache-2.0.txt
/usr/share/licenses/gi-docgen/CC-BY-SA-3.0.txt
/usr/share/licenses/gi-docgen/CC0-1.0.txt
/usr/share/licenses/gi-docgen/GPL-2.0-or-later.txt
/usr/share/licenses/gi-docgen/GPL-3.0-or-later.txt
/usr/share/licenses/gi-docgen/LGPL-2.0-or-later.txt
/usr/share/licenses/gi-docgen/MIT.txt
/usr/share/licenses/gi-docgen/MPL-1.1.txt
/usr/share/licenses/gi-docgen/OFL-1.1.txt
/usr/share/licenses/gi-docgen/dep5
/usr/share/man/man1/gi-docgen.1.gz
/usr/share/pkgconfig/gi-docgen.pc
References
Summary
In this tutorial we learn how to install gi-docgen
on Fedora 36 using yum and [dnf]((/fedora/36/dnf/).