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](https://gnome.pages.gitlab.gnome.org/gi-docgen/tutorial.html).
The documentation for GI-DocGen is [available online](https://gnome.pages.gitlab.gnome.org/gi-docgen/).
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](https://mesonbuild.com),
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](https://hotdoc.github.io/)
- [Doxygen](https://www.doxygen.nl/index.html)
- [GTK-Doc](https://gitlab.gnome.org/GNOME/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.
Raw data
{
"_id": null,
"home_page": "https://gitlab.gnome.org/GNOME/gi-docgen",
"name": "gi-docgen",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": "",
"keywords": "documentation,introspection,gobject,gtk",
"author": "Emmanuele Bassi",
"author_email": "ebassi@gnome.org",
"download_url": "https://files.pythonhosted.org/packages/ec/4e/7ae06ba557a1ef86abcf33c299bf955a4cf69f0b8f6268c6e97029b6329f/gi-docgen-2023.3.tar.gz",
"platform": null,
"description": "GI-DocGen: Documentation tool for GObject-based libraries\n-------------------------------------------------------------------------------\n\nGI-DocGen is a document generator for GObject-based libraries. GObject is\nthe base type system of the GNOME project. GI-Docgen reuses the\nintrospection data generated by GObject-based libraries to generate the API\nreference of these libraries, as well as other ancillary documentation.\n\n## Installation\n\n### Running GI-DocGen uninstalled\n\nYou can run GI-DocGen from its repository, by calling:\n\n```\n./gi-docgen.py\n```\n\nGI-DocGen will automatically detect this case.\n\n### Installing GI-DocGen via pip\n\nTo install GI-DocGen, you will need to have the following pieces of software\navailable on your computer:\n\n - Python 3.6, or later\n - pip\n\nRun the following command:\n\n```\npip3 install --user gi-docgen\n```\n\nAfter running the command above, make sure to have the `~/.local/bin`\ndirectory listed in your `$PATH` environment variable.\n\nTo update GI-DocGen, run the following command:\n\n```\npip3 install --user --upgrade gi-docgen\n```\n\n## Usage\n\nFirst, read [the GI-DocGen tutorial](https://gnome.pages.gitlab.gnome.org/gi-docgen/tutorial.html).\n\nThe documentation for GI-DocGen is [available online](https://gnome.pages.gitlab.gnome.org/gi-docgen/).\n\nThe `examples` directory in the repository contains simple project files for\nvarious GNOME libraries.\n\n## Disclaimer\n\nGI-DocGen is **not** a general purpose documentation tool for C libraries.\n\nWhile GI-DocGen can be used to generate API references for most GObject/C\nlibraries that expose introspection data, its main goal is to generate the\nreference for GTK and its immediate dependencies. Any and all attempts at\nmaking this tool more generic, or to cover more use cases, will be weighted\nheavily against its primary goal.\n\nGI-DocGen is still in development. The recommended use of GI-DocGen is to\nadd it as a sub-project to your [Meson build system](https://mesonbuild.com),\nand vendor it when releasing dist archives.\n\nYou should **not** depend on a system-wide installation until GI-DocGen is\ndeclared stable.\n\nIf you need a general purpose documentation tool, I strongly recommend:\n\n - [HotDoc](https://hotdoc.github.io/)\n - [Doxygen](https://www.doxygen.nl/index.html)\n - [GTK-Doc](https://gitlab.gnome.org/GNOME/gtk-doc/)\n\n## Copyright and Licensing terms\n\nCopyright 2021 GNOME Foundation\n\nGI-DocGen is released under the terms of the Apache License, version 2.0, or\nunder the terms of the GNU General Public License, either version 3.0 or,\nat your option, any later version.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later AND Apache-2.0 AND CC0-1.0",
"summary": "Documentation tool for GObject-based libraries",
"version": "2023.3",
"project_urls": {
"Bug tracker": "https://gitlab.gnome.org/GNOME/gi-docgen/issues/",
"Documentation": "https://gnome.pages.gitlab.gnome.org/gi-docgen/",
"Homepage": "https://gitlab.gnome.org/GNOME/gi-docgen"
},
"split_keywords": [
"documentation",
"introspection",
"gobject",
"gtk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a9a1221564e13c97af17ebf55da41267799b630d0258530152a75feffe99eec",
"md5": "75bbf46b00c56586a7f6d209ab255291",
"sha256": "4375f2e35fdb6fef6dfe7026ede1077fd515a9ca72adc5555db291428a101310"
},
"downloads": -1,
"filename": "gi_docgen-2023.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "75bbf46b00c56586a7f6d209ab255291",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6.0",
"size": 1260856,
"upload_time": "2023-11-25T15:41:56",
"upload_time_iso_8601": "2023-11-25T15:41:56.001662Z",
"url": "https://files.pythonhosted.org/packages/9a/9a/1221564e13c97af17ebf55da41267799b630d0258530152a75feffe99eec/gi_docgen-2023.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec4e7ae06ba557a1ef86abcf33c299bf955a4cf69f0b8f6268c6e97029b6329f",
"md5": "9e6c51bccb72f6d9e0ce092131f03d24",
"sha256": "977616bcc0e2735bb596c71e8eb34533526680740c666e87f9dfc323acd488f0"
},
"downloads": -1,
"filename": "gi-docgen-2023.3.tar.gz",
"has_sig": false,
"md5_digest": "9e6c51bccb72f6d9e0ce092131f03d24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 2525675,
"upload_time": "2023-11-25T15:41:59",
"upload_time_iso_8601": "2023-11-25T15:41:59.475848Z",
"url": "https://files.pythonhosted.org/packages/ec/4e/7ae06ba557a1ef86abcf33c299bf955a4cf69f0b8f6268c6e97029b6329f/gi-docgen-2023.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-25 15:41:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gi-docgen"
}
JSON