Changeset 0977d61 for general/prog

Timestamp:

03/11/2024 11:38:44 AM (7 weeks ago)

Author:

Xi Ruoyao <xry111@…>

Branches:

ken/TL2024, trunk

Children:

70d99ec4

Parents:

311b162

git-author:

Xi Ruoyao <xry111@…> (03/11/2024 11:34:03 AM)

git-committer:

Xi Ruoyao <xry111@…> (03/11/2024 11:38:44 AM)

Message:

gi-docgen: Silence graphviz warnings

File:

• general/prog/python-modules/gi-docgen.xml (modified) (2 diffs)

general/prog/python-modules/gi-docgen.xml

@@ -78 +78 @@
       </para>
 
-      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
+      <bridgehead renderas="sect5">Optional</bridgehead>
       <para role="optional">
-        <xref linkend="pytest"/>
+        <xref role='runtime' linkend='graphviz'/> (runtime, for visualizing
+        class hierarchy graphs) and
+        <xref linkend="pytest"/> (for testing)
       </para>
 
@@ -87 +89 @@
     <sect3 role="installation">
       <title>Installation of gi-docgen</title>
+
+    <!-- https://gitlab.gnome.org/GNOME/gi-docgen/-/issues/188 -->
+    <para>
+      Silence a warning from the Graphviz <command>dot</command> utility
+      which will cause documentation of various packages fail to build
+      if Graphviz is installed but built without Pango, and
+      <command>gi-docgen</command> is invoked with the
+      <option>--fatal-warnings</option> option:
+    </para>
+
+    <screen><userinput>sed 's/"dot", /&amp;"-q", /' -i gidocgen/utils.py</userinput></screen>
 
     <para> Build the module: </para>