From 6d1ef5864b6b3f7244f50847b6355b13ad8de3fd Mon Sep 17 00:00:00 2001
From: traxys <quentin+dev@familleboyer.net>
Date: Sat, 30 Mar 2024 14:52:32 +0100
Subject: [PATCH] docs: Add a section on module specific options (#1355)

This commit only adds Home-Manager specific options, we should add
sections for the different kind of modules too.

This is _not_ added to the man docs, as it is more complex. If need
arises we could look into how to do it.
---
 docs/default.nix        | 12 +++++++++++-
 docs/mdbook/SUMMARY.md  |  4 ++++
 docs/mdbook/default.nix |  7 ++++++-
 docs/modules/hm.md      |  6 ++++++
 wrappers/hm.nix         |  9 +++------
 wrappers/modules/hm.nix |  7 +++++++
 6 files changed, 37 insertions(+), 8 deletions(-)
 create mode 100644 docs/modules/hm.md
 create mode 100644 wrappers/modules/hm.nix

diff --git a/docs/default.nix b/docs/default.nix
index 70fa7b79..12164fbc 100644
--- a/docs/default.nix
+++ b/docs/default.nix
@@ -69,6 +69,16 @@
       })
     ]
     ++ (rawModules pkgsDoc);
+
+  hmOptions =
+    builtins.removeAttrs
+    (lib.evalModules {
+      modules = [
+        (import ../wrappers/modules/hm.nix {inherit lib;})
+      ];
+    })
+    .options
+    ["_module"];
 in
   rec {
     options-json =
@@ -93,6 +103,6 @@ in
     docs = pkgsDoc.callPackage ./mdbook {
       inherit transformOptions;
       modules = topLevelModules;
-      inherit helpers;
+      inherit helpers hmOptions;
     };
   }
diff --git a/docs/mdbook/SUMMARY.md b/docs/mdbook/SUMMARY.md
index c8c9bac7..3ce2fb54 100644
--- a/docs/mdbook/SUMMARY.md
+++ b/docs/mdbook/SUMMARY.md
@@ -7,6 +7,10 @@
 - [Extending a standalone configuration](./user-guide/extending-config.md)
 - [FAQ](./user-guide/faq.md)
 
+# Module Specific Options
+
+- [Home Manager Usage](./modules/hm.md)
+
 # Options
 
 @NIXVIM_OPTIONS@
diff --git a/docs/mdbook/default.nix b/docs/mdbook/default.nix
index 7a3a035b..81615c12 100644
--- a/docs/mdbook/default.nix
+++ b/docs/mdbook/default.nix
@@ -5,6 +5,7 @@
   helpers,
   nixosOptionsDoc,
   transformOptions,
+  hmOptions,
 }:
 with lib; let
   options = lib.evalModules {
@@ -246,6 +247,7 @@ with lib; let
     cp -r --no-preserve=all $inputs/* ./
     cp ${../../CONTRIBUTING.md} ./CONTRIBUTING.md
     cp -r ${../user-guide} ./user-guide
+    cp -r ${../modules} ./modules
 
     # Copy the generated MD docs into the build directory
     # Using pkgs.writeShellScript helps to avoid the "bash: argument list too long" error
@@ -254,7 +256,10 @@ with lib; let
     # Prepare SUMMARY.md for mdBook
     # Using pkgs.writeText helps to avoid the same error as above
     substituteInPlace ./SUMMARY.md \
-      --replace "@NIXVIM_OPTIONS@" "$(cat ${pkgs.writeText "nixvim-options-summary.md" mdbook.nixvimOptions})"
+      --replace-fail "@NIXVIM_OPTIONS@" "$(cat ${pkgs.writeText "nixvim-options-summary.md" mdbook.nixvimOptions})"
+
+    substituteInPlace ./modules/hm.md \
+      --replace-fail "@HM_OPTIONS@" "$(cat ${mkMDDoc hmOptions})"
   '';
 in
   pkgs.stdenv.mkDerivation {
diff --git a/docs/modules/hm.md b/docs/modules/hm.md
new file mode 100644
index 00000000..29121cd5
--- /dev/null
+++ b/docs/modules/hm.md
@@ -0,0 +1,6 @@
+# Home Manager Usage
+
+All nixvim options are available at `programs.nixvim.*` when nixvim is used in home-manager.
+There are a few home-manager specific options that are documented here.
+
+@HM_OPTIONS@
diff --git a/wrappers/hm.nix b/wrappers/hm.nix
index f26ae942..92b6ca06 100644
--- a/wrappers/hm.nix
+++ b/wrappers/hm.nix
@@ -29,12 +29,9 @@ in {
         };
         modules =
           [
-            {
-              options = {
-                enable = mkEnableOption "nixvim";
-                defaultEditor = mkEnableOption "nixvim as the default editor";
-              };
-            }
+            (import ./modules/hm.nix {
+              inherit lib;
+            })
           ]
           ++ shared.topLevelModules;
       };
diff --git a/wrappers/modules/hm.nix b/wrappers/modules/hm.nix
new file mode 100644
index 00000000..10d44a59
--- /dev/null
+++ b/wrappers/modules/hm.nix
@@ -0,0 +1,7 @@
+{lib}:
+with lib; {
+  options = {
+    enable = mkEnableOption "nixvim";
+    defaultEditor = mkEnableOption "nixvim as the default editor";
+  };
+}