vte: API doc now needs gi-docgen instead of gtk-doc

This commit is contained in:
Xi Ruoyao 2023-02-12 00:57:53 +08:00
parent 29cd7e3645
commit ef85ef61f6
No known key found for this signature in database
GPG Key ID: ACAAD20E19E710E3

View File

@ -88,8 +88,8 @@
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="fribidi"/> and
<xref linkend="gtk-doc"/>
<xref linkend="fribidi"/>,
<xref linkend="gi-docgen"/>, and
<xref linkend="gtk4"/>
</para>
@ -162,7 +162,15 @@ rm -v /etc/profile.d/vte.*</userinput></screen>
<para>
<option>-Ddocs=true</option>: Add this switch if wish to
build the documentation.
build the documentation. It requires <xref linkend='gi-docgen'/>.
It's needed to use the
<command>sed '/fatal-warning/d' -i doc/reference/meson.build</command>
command before <command>mkdir build</command> to work around an issue
in the build system if this option will be used. And, if this option
is used, after the installation use the
<command>mv /usr/share/doc/vte-{2.&vte-nano;,&vte-version;}</command>
as the &root; user to move the API documentation into the expected
location.
</para>
<para>
@ -194,7 +202,7 @@ rm -v /etc/profile.d/vte.*</userinput></screen>
</seg>
<seg>
/usr/include/vte-2.&vte-nano; and
(optional) /usr/share/gtk-doc/html/vte-2.&vte-nano;
(optional) /usr/share/doc/vte-&vte-version;
</seg>
</seglistitem>
</segmentedlist>