[glib/ebassi/gdbus-codegen-rst: 8/8] docs: Add --generate-rst to the gdbus-codegen docs

[Emmanuele Bassi <ebassi src gnome org>]

commit ec745d61fb600bd5914c84c778b1bf6526ea3202
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Fri Jan 21 15:27:58 2022 +0000

    docs: Add --generate-rst to the gdbus-codegen docs

 docs/reference/gio/gdbus-codegen.xml | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
---
diff --git a/docs/reference/gio/gdbus-codegen.xml b/docs/reference/gio/gdbus-codegen.xml
index 960b5ffa0..e31f07ced 100644
--- a/docs/reference/gio/gdbus-codegen.xml
+++ b/docs/reference/gio/gdbus-codegen.xml
@@ -35,6 +35,7 @@
     <arg><option>--c-generate-autocleanup</option> none|objects|all</arg>
     <arg><option>--output-directory</option> <replaceable>OUTDIR</replaceable></arg>
     <arg><option>--generate-docbook</option> <replaceable>OUTFILES</replaceable></arg>
+    <arg><option>--generate-rst</option> <replaceable>OUTFILES</replaceable></arg>
     <arg><option>--pragma-once</option></arg>
     <arg><option>--xml-files</option> <replaceable>FILE</replaceable></arg>
     <arg><option>--header</option></arg>
@@ -168,6 +169,16 @@
   </para>
 </refsect1>
 
+<refsect1>
+  <title>Generating reStructuredText documentation</title>
+  <para>
+    Each generated reStructuredText file (see the
+    <option>--generate-rst</option> option for details) is a plain text
+    <ulink url="https://docutils.sourceforge.io/rst.html";>reStructuredText</ulink>
+    document describing the D-Bus interface.
+  </para>
+</refsect1>
+
 <refsect1>
   <title>Options</title>
   <para>
@@ -224,6 +235,23 @@
       </listitem>
     </varlistentry>
 
+    <varlistentry>
+      <term><option>--generate-rst</option> <replaceable>OUTFILES</replaceable></term>
+      <listitem>
+        <para>
+          Generate reStructuredText Documentation for each D-Bus interface and
+          put it in <filename>OUTFILES-NAME.rst</filename> where
+          <literal>NAME</literal> is a place-holder for the interface
+          name, e.g. <literal>net.Corp.FooBar</literal> and so on.
+        </para>
+        <para>
+          Pass <option>--output-directory</option> to specify the directory
+          to put the output files in. By default the current directory
+          will be used.
+        </para>
+      </listitem>
+    </varlistentry>
+
     <varlistentry>
       <term><option>--generate-c-code</option> <replaceable>OUTFILES</replaceable></term>
       <listitem>