Moved string templating to nix

moretea · moretea · commit a801c0bd1a79 · 2017-03-11T00:31:12.000+01:00
diff --git a/doc/default.nix b/doc/default.nix
@@ -3,10 +3,7 @@ let
   lib = pkgs.lib;
   sources = lib.sourceFilesBySuffices ./. [".xml"];
   sources-langs = ./languages-frameworks;
-  libDocJSON = builtins.toFile "options.json" (builtins.toJSON (import ./fn-docs.nix));
-  libDocBook= pkgs.runCommand "options-db.xml" {} ''
-    ${pkgs.ruby}/bin/ruby ${./lib2docbook.rb} < ${libDocJSON} > $out
-  '';
+  libChapter = builtins.toFile "lib.xml" (import ./fn-docs.nix).docChapter;
 in
 pkgs.stdenv.mkDerivation {
   name = "nixpkgs-manual";
@@ -77,7 +74,7 @@ pkgs.stdenv.mkDerivation {
       outputFile = "./languages-frameworks/vim.xml";
     }
   + ''
-    cp ${libDocBook} ./lib.xml
+    cp ${libChapter} ./lib.xml
 
     echo ${lib.nixpkgsVersion} > .version
 
diff --git a/doc/fn-docs.nix b/doc/fn-docs.nix
@@ -29,8 +29,52 @@ let
       set_val = lib.${set};
       documentedFunctions = filterDocumentedFunctions set_val;
     in map (n: {name = ["lib" set n]; docs = mkDocs set_val.${n};  }) documentedFunctions;
+
+  makeDocChapter = topLevel: categorized:
+    let
+      prefix = ''
+        <chapter xmlns="http://docbook.org/ns/docbook"
+                 xmlns:xlink="http://www.w3.org/1999/xlink"
+                 xml:id="chap-lib-functions">
+
+        <title>Library functions</title>
+        <para>This paragraph describes the available library functions.</para>
+      '';
+      postfix = "</chapter>";
+      toplevel.prefix = ''
+        <section xml:id="sec-lib-functions-top-level">
+        <title>Top level functions</title>
+        <para>These functions are available under <varname>pkgs.lib</varname></para>
+      '';
+      toplevel.postfix = "</section>";
+      categories.prefix = ''
+        <section xml:id="sec-lib-functions-all">
+        <title>All library functions</title>
+        <para>These functions are available under <varname>pkgs.$category.$name</varname></para>
+      '';
+      categories.postfix = "</section>";
+      makeDocExample = example:
+            "<para><emphasis>Example:</emphasis><programlisting>${example}</programlisting></para>";
+      makeDocFn = { docs, name }: ''
+        <varlistentry>
+          <term><option>${concatStringsSep "." name}</option></term>
+          <listitem>
+          <para>${docs.description}</para>
+          ${
+            lib.concatStrings (map makeDocExample docs.examples)
+          }
+          </listitem>
+        </varlistentry>
+      '';
+      makeDocFns = fns: "<variablelist>" + (lib.concatStrings (map makeDocFn fns)) + "</variablelist>";
+    in
+    prefix +
+    toplevel.prefix + (makeDocFns topLevel) + toplevel.postfix +
+    categories.prefix + (makeDocFns categorized) + categories.postfix +
+    postfix;
 in
-{
+rec {
   categorized = concatLists (map find_functions sets);
   topLevel = topLevelDocumentedFunctions;
+  docChapter = makeDocChapter topLevel categorized;
 }
diff --git a/doc/lib2docbook.rb b/doc/lib2docbook.rb
