Changeset 5d22507

Timestamp:

02/14/2023 11:15:01 AM (16 months ago)

Author:

Xi Ruoyao <xry111@…>

Branches:

11.3, 12.0, 12.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, plabs/newcss, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, xry111/llvm18, xry111/xf86-video-removal

Children:

37fb447

Parents:

9b8f21a3

Message:

libpeas: Document how to use gi-docgen

File:

• gnome/platform/libpeas.xml (modified) (2 diffs)

gnome/platform/libpeas.xml

@@ -113 +113 @@
 
     <para>
+      If you have <xref linkend='gi-docgen'/> installed and wish to build
+      the API documentation for this package, issue:
+    </para>
+
+<screen role='nodump'><userinput>sed "/docs_dir =/s@\$@/ 'libpeas-&libpeas-version;'@" \
+    -i ../docs/reference/meson.build       &amp;&amp;
+meson configure -Dgtk_doc=true             &amp;&amp;
+ninja</userinput></screen>
+
+    <para>
       To test the results, issue: <command>ninja test</command>.
       An active graphical session with bus address is necessary to
@@ -144 +154 @@
       <option>-Ddemos=false</option>: Add this switch if you do not wish to
       build the demo programs.
-    </para>
-
-    <para>
-      <option>-Dgtk_doc=true</option>: Add this switch if you wish to
-      build the reference manual and you have
-      <xref linkend="gi-docgen"/> installed on your system.
     </para>