doc/lib-functions: print libset name before description

NixOS · Dec 22, 2022 · 5782c3d · 5782c3d
1 parent ce95228
commit 5782c3d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/doc/doc-support/default.nix b/doc/doc-support/default.nix
@@ -4,17 +4,17 @@ let
   inherit (lib) hasPrefix removePrefix;
 
   libsets = [
-    { name = "asserts"; description = "Assert functions"; }
-    { name = "attrsets"; description = "Attribute-set functions"; }
-    { name = "strings"; description = "String manipulation functions"; }
-    { name = "versions"; description = "Version string functions"; }
-    { name = "trivial"; description = "Miscellaneous functions"; }
-    { name = "lists"; description = "List manipulation functions"; }
-    { name = "debug"; description = "Debugging functions"; }
+    { name = "asserts"; description = "assertion functions"; }
+    { name = "attrsets"; description = "attribute set functions"; }
+    { name = "strings"; description = "string manipulation functions"; }
+    { name = "versions"; description = "version string functions"; }
+    { name = "trivial"; description = "miscellaneous functions"; }
+    { name = "lists"; description = "list manipulation functions"; }
+    { name = "debug"; description = "debugging functions"; }
     { name = "options"; description = "NixOS / nixpkgs option handling"; }
-    { name = "filesystem"; description = "Filesystem functions"; }
-    { name = "sources"; description = "Source filtering functions"; }
-    { name = "cli"; description = "Command-line serialization functions"; }
+    { name = "filesystem"; description = "filesystem functions"; }
+    { name = "sources"; description = "source filtering functions"; }
+    { name = "cli"; description = "command-line serialization functions"; }
   ];
 
   locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs libsets; };

diff --git a/doc/doc-support/lib-function-docs.nix b/doc/doc-support/lib-function-docs.nix
@@ -9,7 +9,8 @@ with pkgs; stdenv.mkDerivation {
   buildInputs = [ nixdoc ];
   installPhase = ''
     function docgen {
-      nixdoc -c "$1" -d "$2" -f "$1.nix" > "$out/$1.xml"
+      # TODO: wrap lib.$1 in <literal>, make nixdoc not escape it
+      nixdoc -c "$1" -d "lib.$1: $2" -f "$1.nix" > "$out/$1.xml"
       echo "<xi:include href='$1.xml' />" >> "$out/index.xml"
     }