docs: add html and man pages for options

docs/default.nix

@@ -0,0 +1,55 @@
+# Copyright (c) 2019-2022, see AUTHORS. Licensed under MIT License, see LICENSE.
+
+{ pkgs, home-manager, nmdSrc }:
+
+let
+  nmd = import nmdSrc { inherit pkgs; };
+
+  # Make sure the used package is scrubbed to avoid actually instantiating
+  # derivations.
+  setupModule = {
+    _module.args.pkgs = pkgs.lib.mkForce (nmd.scrubDerivations "pkgs" pkgs);
+  };
+
+  modules = import ../modules/module-list.nix {
+    inherit pkgs;
+    home-manager-path = home-manager.outPath;
+    isFlake = true;
+  };
+
+  modulesDocs = nmd.buildModulesDocs {
+    modules = modules ++ [ setupModule ];
+    moduleRootPaths = [ ../. ];
+    mkModuleUrl = path: "https://github.com/t184256/nix-on-droid/blob/master/${path}";
+    channelName = "nix-on-droid";
+    docBook.id = "nix-on-droid-options";
+  };
+
+  docs = nmd.buildDocBookDocs {
+    pathName = "nix-on-droid";
+    modulesDocs = [ modulesDocs ];
+    documentsDirectory = ./.;
+    chunkToc = ''
+      <toc>
+        <d:tocentry xmlns:d="http://docbook.org/ns/docbook" linkend="book-manual"><?dbhtml filename="index.html"?>
+          <d:tocentry linkend="ch-options"><?dbhtml filename="nix-on-droid-options.html"?></d:tocentry>
+        </d:tocentry>
+      </toc>
+    '';
+  };
+in
+
+{
+  inherit (docs) manPages;
+
+  optionsJson = pkgs.symlinkJoin {
+    name = "nix-on-droid-options-json";
+    paths = [
+      (modulesDocs.json.override {
+        path = "share/doc/nix-on-droid/nix-on-droid-options.json";
+      })
+    ];
+  };
+
+  manualHtml = docs.html;
+}

docs/man-pages.xml

@@ -0,0 +1,38 @@
+<!-- Copyright (c) 2019-2022, see AUTHORS. Licensed under MIT License, see LICENSE. -->
+<reference xmlns="http://docbook.org/ns/docbook"
+           xmlns:xlink="http://www.w3.org/1999/xlink"
+           xmlns:xi="http://www.w3.org/2001/XInclude">
+ <title>Nix-on-Droid Reference Pages</title>
+ <info>
+  <author><personname>Nix-on-Droid contributors</personname>
+  </author>
+  <copyright><year>2022</year><holder>Nix-on-Droid contributors</holder>
+  </copyright>
+ </info>
+ <refentry>
+  <refmeta>
+   <refentrytitle><filename>nix-on-droid-options</filename></refentrytitle>
+   <manvolnum>5</manvolnum>
+   <refmiscinfo class="source">Nix-on-Droid</refmiscinfo>
+  </refmeta>
+  <refnamediv>
+   <refname><filename>nix-on-droid-options</filename>
+   </refname><refpurpose>Nix-on-Droid configuration specification</refpurpose>
+  </refnamediv>
+  <refsection>
+   <title>Description</title>
+   <para>
+    This contains the module options available for Nix-on-Droid.
+   </para>
+  </refsection>
+  <refsection>
+   <title>Options</title>
+   <para>
+    You can use the following options in <filename>nix-on-droid.nix</filename> or in the
+    <varname>modules</varname> argument of <varname>lib.nixOnDroidConfiguration</varname>
+    in your <filename>flake.nix</filename>:
+   </para>
+   <xi:include href="./nmd-result/nix-on-droid-options.xml" />
+  </refsection>
+ </refentry>
+</reference>

docs/manual.xml

@@ -0,0 +1,59 @@
+<!-- Copyright (c) 2019-2022, see AUTHORS. Licensed under MIT License, see LICENSE. -->
+<book xmlns="http://docbook.org/ns/docbook"
+      xmlns:xlink="http://www.w3.org/1999/xlink"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      version="5.0"
+      xml:id="book-manual">
+ <info>
+  <title>Nix-on-Droid manual</title>
+ </info>
+ <preface>
+  <title>Preface</title>
+  <para>
+   Some basic documentation of Nix-on-Droid.
+  </para>
+  <para>
+   If you encounter problems or bugs then please report them on the
+   <link xlink:href="https://github.com/t184256/nix-on-droid/issues">issue tracker</link>.
+  </para>
+ </preface>
+
+ <appendix xml:id="ch-options">
+  <title>Nix-on-Droid configuration options</title>
+  <section xml:id="sec-usage">
+   <title>Usage</title>
+
+   <para>
+    To use these options, edit the config file in
+    <filename>~/.config/nixpkgs/nix-on-droid.nix</filename> or in case of a flake setup,
+    set the <replaceable>modules</replaceable> value in the <varname>nixOnDroidConfiguration</varname>
+    call:
+<programlisting language="nix">
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-22.05";
+
+    nix-on-droid = {
+      url = "github:t184256/nix-on-droid/release-22.05";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+
+  outputs = { self, nixpkgs, nix-on-droid }: {
+
+    nixOnDroidConfigurations.deviceName = nix-on-droid.lib.nixOnDroidConfiguration {
+      <replaceable>modules</replaceable> = [ ./nix-on-droid.nix ];
+    };
+
+  };
+}
+</programlisting>
+   </para>
+  </section>
+  <section xml:id="sec-options">
+   <title>Options</title>
+
+   <xi:include href="./nmd-result/nix-on-droid-options.xml" />
+  </section>
+ </appendix>
+</book>

flake.lock

@@ -90,6 +90,22 @@
         "type": "gitlab"
       }
     },
+    "nmd_2": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1666190571,
+        "narHash": "sha256-Z1hc7M9X6L+H83o9vOprijpzhTfOBjd0KmUTnpHAVjA=",
+        "owner": "rycee",
+        "repo": "nmd",
+        "rev": "b75d312b4f33bd3294cd8ae5c2ca8c6da2afc169",
+        "type": "gitlab"
+      },
+      "original": {
+        "owner": "rycee",
+        "repo": "nmd",
+        "type": "gitlab"
+      }
+    },
     "nmt": {
       "flake": false,
       "locked": {
@@ -111,7 +127,8 @@
         "home-manager": "home-manager",
         "nix-formatter-pack": "nix-formatter-pack",
         "nixpkgs": "nixpkgs",
-        "nixpkgs-for-bootstrap": "nixpkgs-for-bootstrap"
+        "nixpkgs-for-bootstrap": "nixpkgs-for-bootstrap",
+        "nmd": "nmd_2"
       }
     },
     "utils": {

flake.nix

@@ -18,9 +18,14 @@
       url = "github:Gerschtli/nix-formatter-pack";
       inputs.nixpkgs.follows = "nixpkgs";
     };
+
+    nmd = {
+      url = "gitlab:rycee/nmd";
+      flake = false;
+    };
   };
 
-  outputs = { self, nixpkgs, nixpkgs-for-bootstrap, home-manager, nix-formatter-pack }:
+  outputs = { self, nixpkgs, nixpkgs-for-bootstrap, home-manager, nix-formatter-pack, nmd }:
     let
       forEachSystem = nixpkgs.lib.genAttrs [ "aarch64-linux" "x86_64-linux" ];
 
@@ -106,11 +111,19 @@
       overlays.default = overlay;
 
       packages = forEachSystem (system:
-        (import ./pkgs {
+        let
-          inherit system;
+          nixOnDroidPkgs = import ./pkgs {
-          nixpkgs = nixpkgs-for-bootstrap;
+            inherit system;
-        }).customPkgs
+            nixpkgs = nixpkgs-for-bootstrap;
-        // {
+          };
+
+          docs = import ./docs {
+            inherit home-manager;
+            pkgs = nixpkgs.legacyPackages.${system};
+            nmdSrc = nmd;
+          };
+        in
+        {
           fakedroid = import ./tests {
             inherit system;
             nixpkgs = nixpkgs-for-bootstrap;
@@ -118,6 +131,8 @@
 
           nix-on-droid = nixpkgs.legacyPackages.${system}.callPackage ./nix-on-droid { };
         }
+        // nixOnDroidPkgs.customPkgs
+        // docs
       );
 
       templates = {