libshumate: Remove reference to gtk-doc, and add instruction for gi-doc

gtk-doc is checked but never used.
This commit is contained in:
Xi Ruoyao 2023-07-11 18:20:26 +08:00
parent d614533a5b
commit 67e2e7f795
No known key found for this signature in database
GPG Key ID: ACAAD20E19E710E3

View File

@ -75,8 +75,8 @@
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="gi-docgen"/> and
<xref linkend="gtk-doc"/>
<xref linkend="gi-docgen"/>
<!-- and <xref linkend="gtk-doc"/> check but never used -->
</para>
</sect2>
@ -98,6 +98,15 @@ meson setup --prefix=/usr \
.. &amp;&amp;
ninja</userinput></screen>
<para>
If you have <xref linkend='gi-docgen'/> installed and wish to build
the API documentation for this package, issue:
</para>
<screen remap='doc'><userinput>sed 's/lib_version/version/' -i ../docs/meson.build &amp;&amp;
meson configure -Dgtk_doc=true &amp;&amp;
ninja</userinput></screen>
<para>
To test the results, issue: <command>ninja test</command>.
</para>
@ -114,13 +123,6 @@ ninja</userinput></screen>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/meson-buildtype-release.xml"/>
<para>
<parameter>-Dgtk_doc=false</parameter>: This switch disables documentation
generation. Remove this if you have both <xref linkend="gtk-doc"/> and
<xref linkend="gi-docgen"/> installed and wish to generate the API
documentation.
</para>
</sect2>
<sect2 role="content">
@ -139,7 +141,8 @@ ninja</userinput></screen>
libshumate-1.0.so
</seg>
<seg>
/usr/include/shumate-1.0
/usr/include/shumate-1.0 and
/usr/share/doc/libshumate-&libshumate-version; (optional)
</seg>
</seglistitem>
</segmentedlist>