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
Installing GI-DocGen from source
You can also install GI-DocGen from a local copy of its source code repository, but we recommend the methods above for easier and more stable updates. Please make sure the requirements for the installation via pip are present on your machine. Once you are inside the source code directory, run the following command:
python3 setup.py install
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.
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 Publice License, either version 3.0 or, at your option, any later version.
1 maintainer
Release files for gi-docgen 2021.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gi-docgen-2021.1.tar.gz | 62.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gi_docgen-2021.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 1.1 MB
Release files / gi-docgen-2021.1.tar.gz
| Download URL | gi-docgen-2021.1.tar.gz |
|---|---|
| Size | 62.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
73d996ded2a08d3a3d2ee4d9d09bf2bd32c87dbf69da804af3406c48f8c5003a
|
|
BLAKE2b-256 checksum How to use checksums |
1866f2229c27af89380911f52a7366a3e94bdcde046486d383f5044f1034cd53
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.1.3 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.1
|
Release files / gi_docgen-2021.1-py2.py3-none-any.whl
| Download URL | gi_docgen-2021.1-py2.py3-none-any.whl |
|---|---|
| Size | 1.0 MB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
31e244f6d03001e5cafafcbc2391b84996c50f9cc6385e2c7c11b7c6c1b4041c
|
|
BLAKE2b-256 checksum How to use checksums |
3a0e1c28ae3cd6cc619fd54ef46b3d45f57ed365d758842bb9c1b63bceb165c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.1.3 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.1
|
