Commit Graph

9 Commits

Author SHA1 Message Date
Jan Tojnar
87ae4fb3ac docs: Update website link 2024-02-14 12:07:46 +00:00
Christoph Reiter
1bda59fcc9 Add a --version option to g-ir-compiler and g-ir-generate.
Resolves: gobject-introspection#55
2024-02-14 12:07:46 +00:00
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
Tomasz Miąsko
ae313e311d Update bug reporting links.
Also disable automatic hyphenation in manual pages to prevent wrapping
long URLs. Ensures that URLs can be easily navigated by clicking on
them.
2024-02-14 12:07:46 +00:00
Emmanuele Bassi
c7387b504a docs: Remove incorrect name rule
The leading `lib` should be passed as part of the shared library name in
the `--shared-library` argument for g-ir-compiler.

https://bugzilla.gnome.org/show_bug.cgi?id=699354
2024-02-14 12:07:46 +00:00
Ben Boeckel
e24c7f93c9 docs: fix manpage flag formats
Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
2024-02-14 12:07:46 +00:00
Dieter Verfaillie
33b7bc36ad Update bugzilla product/component
g-i bug reports have been moved from:
  http://bugzilla.gnome.org/enter_bug.cgi?product=glib&amp;component=introspection
to:
  http://bugzilla.gnome.org/enter_bug.cgi?product=gobject-introspection

https://bugzilla.gnome.org/show_bug.cgi?id=745498
2024-02-14 12:07:46 +00:00
Dieter Verfaillie
0e11c0ad8d g-ir-compiler: remove references to --code, remove --no-init options
The "--code" option was removed years ago in ac81f3e8c5f1c380d16677232d67466e739da283
so remove references to it from README and g-ir-compiler(1)

Remove the "--no-init" option from g-ir-compiler and g-ir-compiler(1)
as it was documented to "can only be used if --code is also specified",
so no reason to keep it around.
2024-02-14 12:07:46 +00:00
Johan Dahlin
3c65ea7a18 Add man pages for the generator and compiler.
2008-08-29  Johan Dahlin  <johan@gnome.org>

    * Makefile.am:
    * docs/g-ir-compiler.1:
    * docs/g-ir-generate.1:
    * docs/g-ir-scanner.1:
    Add man pages for the generator and compiler.


svn path=/trunk/; revision=518
2024-02-14 12:07:45 +00:00