mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-28 00:16:15 +01:00
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
This commit is contained in:
Christoph Reiter
Simon McVittie
parent
ae313e311d
commit
8d699b6268
@ -1,41 +1,77 @@
|
|||||||
.TH "g-ir-compiler" 1
|
.\" Man page generated from reStructuredText.
|
||||||
.nh
|
.
|
||||||
|
.TH G-IR-COMPILER 1 "" "" ""
|
||||||
.SH NAME
|
.SH NAME
|
||||||
g-ir-compiler \- typelib compiler.
|
g-ir-compiler \- Typelib compiler
|
||||||
|
.
|
||||||
|
.nr rst2man-indent-level 0
|
||||||
|
.
|
||||||
|
.de1 rstReportMargin
|
||||||
|
\\$1 \\n[an-margin]
|
||||||
|
level \\n[rst2man-indent-level]
|
||||||
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||||
|
-
|
||||||
|
\\n[rst2man-indent0]
|
||||||
|
\\n[rst2man-indent1]
|
||||||
|
\\n[rst2man-indent2]
|
||||||
|
..
|
||||||
|
.de1 INDENT
|
||||||
|
.\" .rstReportMargin pre:
|
||||||
|
. RS \\$1
|
||||||
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||||||
|
. nr rst2man-indent-level +1
|
||||||
|
.\" .rstReportMargin post:
|
||||||
|
..
|
||||||
|
.de UNINDENT
|
||||||
|
. RE
|
||||||
|
.\" indent \\n[an-margin]
|
||||||
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||||
|
.nr rst2man-indent-level -1
|
||||||
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||||
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||||
|
..
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B g-ir-compiler
|
.sp
|
||||||
[OPTION...] GIRFILE
|
\fBg\-ir\-compiler\fP [OPTION...] GIRFILE
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
g-ir-compiler converts one or more GIR files into one or more typelib.
|
.sp
|
||||||
The output will be written to standard output unless the --output
|
g\-ir\-compiler converts one or more GIR files into one or more typelib. The
|
||||||
is specified.
|
output will be written to standard output unless the \fB\-\-output\fP is
|
||||||
|
specified.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
.B \--help
|
.B \-\-help
|
||||||
Show help options
|
Show help options
|
||||||
.TP
|
.TP
|
||||||
.B \--output=FILENAME
|
.BI \-\-output\fB= FILENAME
|
||||||
Save the resulting output in FILENAME.
|
Save the resulting output in FILENAME.
|
||||||
.TP
|
.TP
|
||||||
.B \--verbose
|
.B \-\-verbose
|
||||||
Show verbose messages
|
Show verbose messages
|
||||||
.TP
|
.TP
|
||||||
.B \--debug
|
.B \-\-debug
|
||||||
Show debug messages
|
Show debug messages
|
||||||
.TP
|
.TP
|
||||||
.B \--includedir=DIRECTORY
|
.BI \-\-includedir\fB= DIRECTORY
|
||||||
Adds a directory which will be used to find includes inside the GIR format.
|
Adds a directory which will be used to find includes inside the GIR format.
|
||||||
.TP
|
.TP
|
||||||
.B \--module=MODULE
|
.BI \-\-module\fB= MODULE
|
||||||
FIXME
|
FIXME
|
||||||
.TP
|
.TP
|
||||||
.B \--shared-library=FILENAME
|
.BI \-\-shared\-library\fB= FILENAME
|
||||||
Specifies the shared library where the symbols in the typelib can be found.
|
Specifies the shared library where the symbols in the typelib can be
|
||||||
The name of the library should not contain the ending shared library suffix.
|
found. The name of the library should not contain the ending shared
|
||||||
.TP
|
library suffix.
|
||||||
|
.UNINDENT
|
||||||
.SH BUGS
|
.SH BUGS
|
||||||
Report bugs at https://gitlab.gnome.org/GNOME/gobject\-introspection/issues.
|
.sp
|
||||||
.SH HOMEPAGE and CONTACT
|
Report bugs at \fI\%https://gitlab.gnome.org/GNOME/gobject\-introspection/issues\fP
|
||||||
http://live.gnome.org/GObjectIntrospection
|
.SH HOMEPAGE AND CONTACT
|
||||||
|
.sp
|
||||||
|
\fI\%http://live.gnome.org/GObjectIntrospection\fP
|
||||||
.SH AUTHORS
|
.SH AUTHORS
|
||||||
|
.sp
|
||||||
Mattias Clasen
|
Mattias Clasen
|
||||||
|
.\" Generated by docutils manpage writer.
|
||||||
|
.
|
||||||
|
|||||||
@ -1,29 +1,63 @@
|
|||||||
.TH "g-ir-generate" 1
|
.\" Man page generated from reStructuredText.
|
||||||
.nh
|
.
|
||||||
|
.TH G-IR-GENERATE 1 "" "" ""
|
||||||
.SH NAME
|
.SH NAME
|
||||||
g-ir-generate \- typelib generator
|
g-ir-generate \- Typelib generator
|
||||||
|
.
|
||||||
|
.nr rst2man-indent-level 0
|
||||||
|
.
|
||||||
|
.de1 rstReportMargin
|
||||||
|
\\$1 \\n[an-margin]
|
||||||
|
level \\n[rst2man-indent-level]
|
||||||
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||||
|
-
|
||||||
|
\\n[rst2man-indent0]
|
||||||
|
\\n[rst2man-indent1]
|
||||||
|
\\n[rst2man-indent2]
|
||||||
|
..
|
||||||
|
.de1 INDENT
|
||||||
|
.\" .rstReportMargin pre:
|
||||||
|
. RS \\$1
|
||||||
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||||||
|
. nr rst2man-indent-level +1
|
||||||
|
.\" .rstReportMargin post:
|
||||||
|
..
|
||||||
|
.de UNINDENT
|
||||||
|
. RE
|
||||||
|
.\" indent \\n[an-margin]
|
||||||
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||||
|
.nr rst2man-indent-level -1
|
||||||
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||||
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||||
|
..
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B g-ir-generate
|
.sp
|
||||||
[OPTION...] FILES...
|
\fBg\-ir\-generate\fP [OPTION...] FILES...
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
g-ir-generate is an GIR generator, using the repository API. It generates
|
.sp
|
||||||
GIR files from a raw typelib or in a shared library (--shlib).
|
g\-ir\-generate is an GIR generator, using the repository API. It generates GIR
|
||||||
The output will be written to standard output unless the --output
|
files from a raw typelib or in a shared library (\fB\-\-shlib\fP). The output will
|
||||||
is specified.
|
be written to standard output unless the \fB\-\-output\fP is specified.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
.B \, --help
|
.B \-\-help
|
||||||
Show help options
|
Show help options
|
||||||
.TP
|
.TP
|
||||||
.B \, --shlib=FILENAME
|
.BI \-\-shlib\fB= FILENAME
|
||||||
The shared library to read the symbols from.
|
The shared library to read the symbols from.
|
||||||
.TP
|
.TP
|
||||||
.B \, --output=FILENAME
|
.BI \-\-output\fB= FILENAME
|
||||||
Save the resulting output in FILENAME.
|
Save the resulting output in FILENAME.
|
||||||
.TP
|
.UNINDENT
|
||||||
.SH BUGS
|
.SH BUGS
|
||||||
Report bugs at https://gitlab.gnome.org/GNOME/gobject\-introspection/issues.
|
.sp
|
||||||
.SH HOMEPAGE and CONTACT
|
Report bugs at \fI\%https://gitlab.gnome.org/GNOME/gobject\-introspection/issues\fP
|
||||||
http://live.gnome.org/GObjectIntrospection
|
.SH HOMEPAGE AND CONTACT
|
||||||
|
.sp
|
||||||
|
\fI\%http://live.gnome.org/GObjectIntrospection\fP
|
||||||
.SH AUTHORS
|
.SH AUTHORS
|
||||||
|
.sp
|
||||||
Mattias Clasen
|
Mattias Clasen
|
||||||
|
.\" Generated by docutils manpage writer.
|
||||||
|
.
|
||||||
|
|||||||
68
docs/website/tools/g-ir-compiler.rst
Normal file
68
docs/website/tools/g-ir-compiler.rst
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
=============
|
||||||
|
g-ir-compiler
|
||||||
|
=============
|
||||||
|
|
||||||
|
----------------
|
||||||
|
Typelib compiler
|
||||||
|
----------------
|
||||||
|
|
||||||
|
:Manual section: 1
|
||||||
|
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
========
|
||||||
|
|
||||||
|
**g-ir-compiler** [OPTION...] GIRFILE
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
===========
|
||||||
|
|
||||||
|
g-ir-compiler converts one or more GIR files into one or more typelib. The
|
||||||
|
output will be written to standard output unless the ``--output`` is
|
||||||
|
specified.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
=======
|
||||||
|
|
||||||
|
--help
|
||||||
|
Show help options
|
||||||
|
|
||||||
|
--output=FILENAME
|
||||||
|
Save the resulting output in FILENAME.
|
||||||
|
|
||||||
|
--verbose
|
||||||
|
Show verbose messages
|
||||||
|
|
||||||
|
--debug
|
||||||
|
Show debug messages
|
||||||
|
|
||||||
|
--includedir=DIRECTORY
|
||||||
|
Adds a directory which will be used to find includes inside the GIR format.
|
||||||
|
|
||||||
|
--module=MODULE
|
||||||
|
FIXME
|
||||||
|
|
||||||
|
--shared-library=FILENAME
|
||||||
|
Specifies the shared library where the symbols in the typelib can be
|
||||||
|
found. The name of the library should not contain the ending shared
|
||||||
|
library suffix.
|
||||||
|
|
||||||
|
|
||||||
|
BUGS
|
||||||
|
====
|
||||||
|
|
||||||
|
Report bugs at https://gitlab.gnome.org/GNOME/gobject-introspection/issues
|
||||||
|
|
||||||
|
|
||||||
|
HOMEPAGE and CONTACT
|
||||||
|
====================
|
||||||
|
|
||||||
|
http://live.gnome.org/GObjectIntrospection
|
||||||
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
=======
|
||||||
|
|
||||||
|
Mattias Clasen
|
||||||
54
docs/website/tools/g-ir-generate.rst
Normal file
54
docs/website/tools/g-ir-generate.rst
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
=============
|
||||||
|
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
|
||||||
Loading…
Reference in New Issue
Block a user