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/tools/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/tools/index.rst')
| -rw-r--r-- | docs/website/tools/index.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/website/tools/index.rst b/docs/website/tools/index.rst new file mode 100644 index 00000000..44897b6c --- /dev/null +++ b/docs/website/tools/index.rst @@ -0,0 +1,21 @@ +================== +Command Line Tools +================== + +.. toctree:: + :hidden: + :titlesonly: + :maxdepth: 1 + + g-ir-compiler + g-ir-generate + g-ir-scanner + +:doc:`g-ir-compiler` + Typelib compiler + +:doc:`g-ir-generate` + Typelib generator + +:doc:`g-ir-scanner` + Extracting C metadata from sources and headers |