summary refs log tree commit diff
path: root/nixos/doc/manual
diff options
context:
space:
mode:
authorDomen Kožar <domen@dev.si>2016-08-28 13:57:34 +0200
committerGitHub <noreply@github.com>2016-08-28 13:57:34 +0200
commite01e92f12f5e768e5bd5ef84a969b978fb501186 (patch)
tree2ea53d8580dd79c3fd9e37354e9b0100010654b8 /nixos/doc/manual
parent4af09e00311b3c024395b59261a32a5a6a43e3fa (diff)
parent4cdfeb78f9b7397304a58b83d2746fd417e00e3c (diff)
downloadnixlib-e01e92f12f5e768e5bd5ef84a969b978fb501186.tar
nixlib-e01e92f12f5e768e5bd5ef84a969b978fb501186.tar.gz
nixlib-e01e92f12f5e768e5bd5ef84a969b978fb501186.tar.bz2
nixlib-e01e92f12f5e768e5bd5ef84a969b978fb501186.tar.lz
nixlib-e01e92f12f5e768e5bd5ef84a969b978fb501186.tar.xz
nixlib-e01e92f12f5e768e5bd5ef84a969b978fb501186.tar.zst
nixlib-e01e92f12f5e768e5bd5ef84a969b978fb501186.zip
Merge pull request #15025 from ericsagnes/modules/manual
manual: automatically generate modules documentation
Diffstat (limited to 'nixos/doc/manual')
-rw-r--r--nixos/doc/manual/configuration/configuration.xml8
-rw-r--r--nixos/doc/manual/default.nix11
2 files changed, 12 insertions, 7 deletions
diff --git a/nixos/doc/manual/configuration/configuration.xml b/nixos/doc/manual/configuration/configuration.xml
index 26f8ebad7344..2d5281829ed5 100644
--- a/nixos/doc/manual/configuration/configuration.xml
+++ b/nixos/doc/manual/configuration/configuration.xml
@@ -25,14 +25,10 @@ effect after you run <command>nixos-rebuild</command>.</para>
 <xi:include href="linux-kernel.xml" />
 <xi:include href="grsecurity.xml" />
 
-<!-- FIXME: auto-include NixOS module docs -->
-<xi:include href="postgresql.xml" />
-<xi:include href="gitlab.xml" />
-<xi:include href="taskserver.xml" />
-<xi:include href="acme.xml" />
-<xi:include href="input-methods.xml" />
 <xi:include href="emacs.xml" />
+<xi:include href="modules.xml" xpointer="xpointer(//section[@id='modules']/*)" />
 
 <!-- Apache; libvirtd virtualisation -->
 
 </part>
+
diff --git a/nixos/doc/manual/default.nix b/nixos/doc/manual/default.nix
index 2592766ee496..0f0c6e66e4c0 100644
--- a/nixos/doc/manual/default.nix
+++ b/nixos/doc/manual/default.nix
@@ -1,4 +1,4 @@
-{ pkgs, options, version, revision, extraSources ? [] }:
+{ pkgs, options, config, version, revision, extraSources ? [] }:
 
 with pkgs;
 
@@ -51,6 +51,14 @@ let
 
   sources = lib.sourceFilesBySuffices ./. [".xml"];
 
+  modulesDoc = builtins.toFile "modules.xml" ''
+    <section xmlns:xi="http://www.w3.org/2001/XInclude" id="modules">
+    ${(lib.concatMapStrings (path: ''
+      <xi:include href="${path}" />
+    '') (lib.catAttrs "value" config.meta.doc))}
+    </section>
+  '';
+
   copySources =
     ''
       cp -prd $sources/* . # */
@@ -61,6 +69,7 @@ let
       cp ${../../modules/security/acme.xml} configuration/acme.xml
       cp ${../../modules/i18n/input-method/default.xml} configuration/input-methods.xml
       cp ${../../modules/services/editors/emacs.xml} configuration/emacs.xml
+      ln -s ${modulesDoc} configuration/modules.xml
       ln -s ${optionsDocBook} options-db.xml
       echo "${version}" > version
     '';