summary refs log tree commit diff
path: root/nixos/lib/make-options-doc
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2023-01-19 00:17:05 +0100
committerpennae <82953136+pennae@users.noreply.github.com>2023-01-22 17:50:09 +0100
commitc93e5dde6762764f09e9cdffbfcda4217092cb1f (patch)
tree860a202831a5a96a3ab25af9e6e46768387840c4 /nixos/lib/make-options-doc
parent3a5f1ae029318b72d4bdbf8ad2c4cf7d04ce7d02 (diff)
downloadnixpkgs-c93e5dde6762764f09e9cdffbfcda4217092cb1f.tar
nixpkgs-c93e5dde6762764f09e9cdffbfcda4217092cb1f.tar.gz
nixpkgs-c93e5dde6762764f09e9cdffbfcda4217092cb1f.tar.bz2
nixpkgs-c93e5dde6762764f09e9cdffbfcda4217092cb1f.tar.lz
nixpkgs-c93e5dde6762764f09e9cdffbfcda4217092cb1f.tar.xz
nixpkgs-c93e5dde6762764f09e9cdffbfcda4217092cb1f.tar.zst
nixpkgs-c93e5dde6762764f09e9cdffbfcda4217092cb1f.zip
nixos/make-options-doc: rearrange paras in related packages/defaults/examples
this mirrors what we will be able to create with markdown. no change to
rendered outputs.
Diffstat (limited to 'nixos/lib/make-options-doc')
-rw-r--r--nixos/lib/make-options-doc/mergeJSON.py7
-rw-r--r--nixos/lib/make-options-doc/options-to-docbook.xsl5
2 files changed, 7 insertions, 5 deletions
diff --git a/nixos/lib/make-options-doc/mergeJSON.py b/nixos/lib/make-options-doc/mergeJSON.py
index cdbf7cc21f0..ef9f321e114 100644
--- a/nixos/lib/make-options-doc/mergeJSON.py
+++ b/nixos/lib/make-options-doc/mergeJSON.py
@@ -220,8 +220,11 @@ def convertMD(options: Dict[str, Any]) -> str:
             # inline literals need a space to separate ticks from content, code blocks
             # need newlines. inline literals need one extra tick, code blocks need three.
             ticks, sep = ('`' * (longest + (3 if multiline else 1)), '\n' if multiline else ' ')
-            docbook = convertString(name, f"*{key.capitalize()}:*\n{ticks}{sep}{code}{sep}{ticks}")
-            option[rendered] = f"<para>{docbook}</para>"
+            docbook = convertString(name, f"{ticks}{sep}{code}{sep}{ticks}")
+            if multiline:
+                option[rendered] = f"<para><emphasis>{key.capitalize()}:</emphasis></para> {docbook}"
+            else:
+                option[rendered] = f"<para><emphasis>{key.capitalize()}:</emphasis> {docbook}</para>"
         elif optionIs(option, key, 'literalDocBook'):
             option[rendered] = f"<para><emphasis>{key.capitalize()}:</emphasis> {option[key]['text']}</para>"
         elif key in option:
diff --git a/nixos/lib/make-options-doc/options-to-docbook.xsl b/nixos/lib/make-options-doc/options-to-docbook.xsl
index 7a80931df0d..a74429596b8 100644
--- a/nixos/lib/make-options-doc/options-to-docbook.xsl
+++ b/nixos/lib/make-options-doc/options-to-docbook.xsl
@@ -85,10 +85,9 @@
               <xsl:if test="attr[@name = 'relatedPackages']">
                 <para>
                   <emphasis>Related packages:</emphasis>
-                  <xsl:text> </xsl:text>
-                  <xsl:value-of disable-output-escaping="yes"
-                                select="attr[@name = 'relatedPackages']/string/@value" />
                 </para>
+                <xsl:value-of disable-output-escaping="yes"
+                              select="attr[@name = 'relatedPackages']/string/@value" />
               </xsl:if>
 
               <xsl:if test="count(attr[@name = 'declarations']/list/*) != 0">