glib/docs/website/tools/g-ir-generate.rst
Christoph Reiter 8d699b6268 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
2024-02-14 12:07:46 +00:00

55 lines
816 B
ReStructuredText

=============
g-ir-generate
=============
-----------------
Typelib generator
-----------------
:Manual section: 1
SYNOPSIS
========
**g-ir-generate** [OPTION...] FILES...
DESCRIPTION
===========
g-ir-generate is an GIR generator, using the repository API. It generates GIR
files from a raw typelib or in a shared library (``--shlib``). The output will
be written to standard output unless the ``--output`` is specified.
OPTIONS
=======
--help
Show help options
--shlib=FILENAME
The shared library to read the symbols from.
--output=FILENAME
Save the resulting output in FILENAME.
BUGS
====
Report bugs at https://gitlab.gnome.org/GNOME/gobject-introspection/issues
HOMEPAGE and CONTACT
====================
http://live.gnome.org/GObjectIntrospection
AUTHORS
=======
Mattias Clasen