diff options
author | Christoph Reiter <reiter.christoph@gmail.com> | 2018-06-10 11:24:47 +0200 |
---|---|---|
committer | Christoph Reiter <reiter.christoph@gmail.com> | 2018-06-16 11:47:01 +0200 |
commit | 539dfca540759b8a97e6906981d4240ca044af9f (patch) | |
tree | 52562f8e255e8a663ab27e44c8bf1b8d7a9a6cf0 /docs/website/index.rst | |
parent | 06660d70e1899d9ad9b3c951073fb9a13652da9d (diff) | |
download | gobject-introspection-539dfca540759b8a97e6906981d4240ca044af9f.tar.gz |
Sphinx based user documentation
The current output (more or less a straight copy of the wiki) is available
here:
https://gi.readthedocs.io
This contains two changes:
* Converts all (not completely outdated) wiki pages to a sphinx based
documentation.
* Converts the man pages to reST and adds a Makefile for building them
using rst2man. So they can be easily exposed in the sphinx docs.
Goals:
* Have a user focused/compact documentation instead of random wiki pages
with various todo/ideas pages.
* Take advantage of the gitlab MR workflow by
* allowing large documentation changes/refactorings with reviews
* allowing to combine features changes with documentation changes in MRs
Diffstat (limited to 'docs/website/index.rst')
-rw-r--r-- | docs/website/index.rst | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/website/index.rst b/docs/website/index.rst new file mode 100644 index 00000000..9b46fe5d --- /dev/null +++ b/docs/website/index.rst @@ -0,0 +1,71 @@ +===================== +GObject Introspection +===================== + +.. title:: Overview + +.. toctree:: + :hidden: + :titlesonly: + :maxdepth: 1 + + goals + architecture + users + writingbindableapis + buildsystems/index + annotations/index + writingbindings/index + tools/index + +GObject introspection is a middleware layer between C libraries (using +GObject) and language bindings. The C library can be scanned at compile time +and generate metadata files, in addition to the actual native C library. Then +language bindings can read this metadata and automatically provide bindings to +call into the C library. + +.. figure:: images/overview.svg + :width: 85% + :align: center + +The GI project consists of: + +* an XML format called GIR containing introspection information in a machine parseable format +* a Python package to create and parse the GIR format +* a scanner to generate GIR format from C source and headers +* a typelib similar to xpcom/msole which stores the information on disk in a binary format +* a compiler to compile the typelib from a xml format (and vice versa) +* C library to read the typelib, :doc:`writingbindings/libgirepository`. + + +Getting the code +---------------- + +The latest stable release is available from +https://download.gnome.org/sources/gobject-introspection + +GObject Introspection is stored in git and can be fetched: + +.. code-block:: text + + git clone https://gitlab.gnome.org/GNOME/gobject-introspection.git + +You can browse the repository online `here <https://gitlab.gnome.org/GNOME/gobject-introspection/>`__. + + +Reporting bugs +-------------- + +For a list of existing bugs and feature requests, see the `issues page +<https://gitlab.gnome.org/GNOME/gobject-introspection/issues>`__. You can also +`open an issue +<https://gitlab.gnome.org/GNOME/gobject-introspection/issues/new>`__. + + +Contact +------- + +For questions or additional information, please use: + +* Mailing list: gtk-devel-list@gnome.org +* IRC: #introspection on irc.gnome.org |