docs: fix documentation generation

volkswagenfeature · Dec 29, 2022 · dd9ec12 · dd9ec12
1 parent 5f67918
commit dd9ec12
Show file tree

Hide file tree

Showing 41 changed files with 55 additions and 552 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -56,4 +56,4 @@ workflows:
             - build-docs
           filters:
             branches:
-              only: main
+              only: main
diff --git a/docs.nix b/docs.nix
@@ -0,0 +1,35 @@
+{ pkgs, lib, modules, ... }:
+let
+  options = lib.evalModules {
+    modules = modules;
+    specialArgs = { inherit pkgs lib; };
+  };
+  docs = pkgs.nixosOptionsDoc {
+    # If we don't do this, we end up with _module.args on the generated options, which we do not want
+    options = lib.filterAttrs (k: _: k != "_module") options.options;
+    warningsAreErrors = false;
+  };
+  asciidoc = docs.optionsAsciiDoc;
+in
+pkgs.stdenv.mkDerivation {
+  name = "nixvim-docs";
+
+  src = asciidoc;
+  buildInputs = [
+    pkgs.asciidoctor
+  ];
+
+  phases = [ "buildPhase" ];
+
+  buildPhase = ''
+    mkdir -p $out/share
+    cat <<EOF > header.adoc
+    = NixVim options
+    This lists all the options available for NixVim.
+    :toc:
+
+    EOF
+    cat header.adoc $src > tmp.adoc
+    asciidoctor tmp.adoc -o $out/share/index.html
+  '';
+}
diff --git a/docs/default.nix b/docs/default.nix
diff --git a/docs/man-nixvim.xml b/docs/man-nixvim.xml
diff --git a/docs/man-pages.xml b/docs/man-pages.xml
diff --git a/docs/manual.xml b/docs/manual.xml
diff --git a/docs/plugins.md b/docs/plugins.md
diff --git a/docs/plugins/colorschemes/base16.md b/docs/plugins/colorschemes/base16.md