jalil/configuration.nix
1
1
Fork 0
Code Issues 2 Pull requests 3 Projects Activity Actions

feat(docs): Add neovim module documentation

Browse source
This commit is contained in:
Jalil David Salamé Messina 2024-02-16 20:36:20 +01:00
parent d47b04a887
commit db8bae6f31
Signed by: jalil
GPG key ID: F016B9E770737A0B
5 changed files with 132 additions and 121 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/default.nix
View file

@ -6,22 +6,15 @@ let
hash = "sha256-pLP73zlmGkbC/zV6bwnB6ijRf9gVkj5/VYMGLhiQ1/Q=";
};
filterVisible = toplevelOption: option: option // { visible = option.visible && builtins.elemAt option.loc 0 == toplevelOption; };
home-eval = lib.evalModules { modules = [ ../home/options.nix ]; specialArgs = { inherit pkgs; }; };
nvim-eval = lib.evalModules { modules = [ ../nvim/options.nix ]; };
nixos-eval = lib.evalModules { modules = [ ../nixos/options.nix ]; };
home-eval = lib.evalModules {
modules = [ ../home/options.nix ];
specialArgs = { inherit pkgs; };
};
nixos-markdown = (pkgs.nixosOptionsDoc {
inherit (nixos-eval) options;
transformOptions = filterVisible "jconfig";
}).optionsCommonMark;
home-markdown = (pkgs.nixosOptionsDoc {
inherit (home-eval) options;
transformOptions = filterVisible "jhome";
}).optionsCommonMark;
home-markdown = (pkgs.nixosOptionsDoc { inherit (home-eval) options; transformOptions = filterVisible "jhome"; }).optionsCommonMark;
nvim-markdown = (pkgs.nixosOptionsDoc { inherit (nvim-eval) options; transformOptions = filterVisible "jhome"; }).optionsCommonMark;
nixos-markdown = (pkgs.nixosOptionsDoc { inherit (nixos-eval) options; transformOptions = filterVisible "jconfig"; }).optionsCommonMark;
in
{
inherit nixos-markdown home-markdown;
inherit nixos-markdown nvim-markdown home-markdown;
docs = pkgs.stdenvNoCC.mkDerivation {
name = "nixos-configuration-book";
src = ./.;
@ -31,8 +24,9 @@ in
ln -s ${highlight} ./theme/highlight.js
# copy generated options removing the declared by statement
sed '/^\*Declared by:\*$/,/^$/d' <${home-markdown} >> src/home-options.md
sed '/^\*Declared by:\*$/,/^$/d' <${nixos-markdown} >> src/nixos-options.md
sed '/^\*Declared by:\*$/,/^$/d' <${home-markdown} >> ./src/home-options.md
sed '/^\*Declared by:\*$/,/^$/d' <${nvim-markdown} >> ./src/nvim-options.md
sed '/^\*Declared by:\*$/,/^$/d' <${nixos-markdown} >> ./src/nixos-options.md
'';
nativeBuildInputs = [ pkgs.mdbook-toc ];

1
docs/src/SUMMARY.md
View file

@ -2,4 +2,5 @@
- [Nix Based Configuration](./configuration-overview.md)
- [NixOS Module Options](./nixos-options.md)
- [Neovim Module Options](./nvim-options.md)
- [Home Manager Module Options](./home-options.md)

13
docs/src/nvim-options.md Normal file
View file

@ -0,0 +1,13 @@
# Neovim Module Options
Here you will find the neovim options and their default values (if they have
any).
You might also want to take a look at the [NixNeovim
Manual](https://nixneovim.github.io/NixNeovim/options.html) or search the
available options through [NixNeovim option
search](https://nixneovim.github.io/nixneovim-option-search/).
## Table of Contents
<!-- toc -->