NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-11-22 21:30:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: use nixosOptionDocs

Browse source 
NixOS 23.11 is deprecating DocBook option documentation. Following home-manager in this change is probably a good idea
This commit is contained in:
raf 2023-11-04 14:30:04 +03:00
parent e498331ce7
commit 3de5f1ba39
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
10 changed files with 91 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
docs/default.nix
View file

@ -29,25 +29,68 @@
];
};
githubDeclaration = user: repo: subpath: let
urlRef = "main";
in {
url = "https://github.com/${user}/${repo}/blob/${urlRef}/${subpath}";
name = "<${repo}/${subpath}>";
};
dontCheckDefinitions = {_module.check = false;};
nvimModuleDocs = nmd.buildModulesDocs {
nvimPath = toString ./..;
buildOptionsDocs = args @ {
modules,
includeModuleSystemsOptions ? true,
...
}: let
options = (lib.evalModules {inherit modules;}).options;
in
pkgs.buildPackages.nixosOptionsDoc
({
options =
if includeModuleSystemsOptions
then options
else builtins.removeAttrs (options ["_module"]);
transformOptions = opt:
opt
// {
# Clean up declaration sites to not refer to local source tree
declarations =
map
(decl:
if lib.hasPrefix nvimPath (toString decl)
then
githubDeclaration "notashelf" "neovim-flake"
(lib.removePrefix "/" (lib.removePrefix nvimPath (toString decl)))
else decl)
opt.declarations;
};
}
// builtins.removeAttrs args ["modules" "includeModuleSystemsOptions"]);
nvimModuleDocs = buildOptionsDocs {
modules =
import ../modules/modules.nix {
import ../modules/modules.nix
{
inherit pkgs lib;
check = false;
}
++ [scrubbedPkgsModule dontCheckDefinitions];
moduleRootPaths = [./..];
mkModuleUrl = path: "https://github.com/notashelf/neovim-flake/blob/main/${path}#blob-path";
channelName = "neovim-flake";
docBook.id = "neovim-flake-options";
++ [scrubbedPkgsModule];
variablelistId = "neovim-flake-options";
};
docs = nmd.buildDocBookDocs {
pathName = "neovim-flake";
projectName = "neovim-flake";
modulesDocs = [nvimModuleDocs];
modulesDocs = [
{
docBook = pkgs.linkFarm "nvim-module-docs-for-nmd" {
"nmd-result/neovim-flake-options.xml" = nvimModuleDocs.optionsDocBook;
};
}
];
documentsDirectory = ./.;
documentType = "book";
chunkToc = ''
@ -65,7 +108,24 @@
'';
};
in {
options.json = nvimModuleDocs.json.override {path = "share/doc/neovim-flake/options.json";};
manPages = docs.manPages;
options.json =
pkgs.runCommand "options.json"
# TODO: Use `nvimOptionsDoc.optionsJSON` directly once upstream
# `nixosOptionsDoc` is more customizable
{
meta.description = "List of neovim-flake options in JSON format";
} ''
mkdir -p $out/{share/doc,nix-support}
cp -a ${nvimModuleDocs.optionsJSON}/share/doc/nixos $out/share/doc/neovim-flake
substitute \
${nvimModuleDocs.optionsJSON}/nix-support/hydra-build-products \
$out/nix-support/hydra-build-products \
--replace \
'${nvimModuleDocs.optionsJSON}/share/doc/nixos' \
"$out/share/doc/neovim-flake"
'';
inherit (docs) manPages;
manual = {inherit (docs) html htmlOpenTool;};
}

2
modules/autopairs/nvim-autopairs/nvim-autopairs.nix
View file

@ -15,7 +15,7 @@ with builtins; {
map_cr = mkOption {
type = types.bool;
default = true;
description = nvim.nmd.asciiDoc ''map <CR> on insert mode'';
description = ''map <CR> on insert mode'';
};
map_complete = mkOption {

13
modules/completion/nvim-cmp/nvim-cmp.nix
View file

@ -22,7 +22,7 @@ with builtins; {
};
sources = mkOption {
description = nvim.nmd.asciiDoc ''
description = ''
Attribute set of source names for nvim-cmp.
If an attribute set is provided, then the menu value of
@ -40,23 +40,22 @@ with builtins; {
formatting = {
format = mkOption {
description = nvim.nmd.asciiDoc ''
description = ''
The function used to customize the appearance of the completion menu.
If <<opt-vim.lsp.lspkind.enable>> is true, then the function
If {option}`vim.lsp.lspkind.enable` is true, then the function
will be called before modifications from lspkind.
Default is to call the menu mapping function.
'';
type = types.str;
default = "nvim_cmp_menu_map";
example = nvim.nmd.literalAsciiDoc ''
[source,lua]
---
example = ''
```lua
function(entry, vim_item)
return vim_item
end
---
```
'';
};
};

10
modules/core/default.nix
View file

@ -27,23 +27,23 @@ with builtins; let
mapConfigOptions = {
silent =
mkBool false
(nvim.nmd.asciiDoc "Whether this mapping should be silent. Equivalent to adding <silent> to a map.");
"Whether this mapping should be silent. Equivalent to adding <silent> to a map.";
nowait =
mkBool false
(nvim.nmd.asciiDoc "Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.");
"Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.";
script =
mkBool false
(nvim.nmd.asciiDoc "Equivalent to adding <script> to a map.");
"Equivalent to adding <script> to a map.";
expr =
mkBool false
(nvim.nmd.asciiDoc "Means that the action is actually an expression. Equivalent to adding <expr> to a map.");
"Means that the action is actually an expression. Equivalent to adding <expr> to a map.";
unique =
mkBool false
(nvim.nmd.asciiDoc "Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.");
"Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.";
noremap =
mkBool true

1
modules/filetree/nvimtree/nvimtree.nix
View file

@ -580,6 +580,7 @@ with builtins; {
icons = mkOption {
type = types.attrs;
description = "Individual elements of the indent markers";
default = {
corner = "└";
edge = "│";

2
modules/statusline/lualine/lualine.nix
View file

@ -84,7 +84,7 @@ in {
default = "auto";
# TODO: xml generation error if the closing '' is on a new line.
# issue: https://gitlab.com/rycee/nmd/-/issues/10
defaultText = nvim.nmd.literalAsciiDoc ''`config.vim.theme.name` if theme supports lualine else "auto"'';
defaultText = ''`config.vim.theme.name` if theme supports lualine else "auto"'';
};
sectionSeparator = {

4
modules/treesitter/context.nix
View file

@ -37,7 +37,7 @@ in {
};
trimScope = mkOption {
description = nvim.nmd.asciiDoc "Which context lines to discard if <<opt-vim.treesitter.context.maxLines>> is exceeded.";
description = "Which context lines to discard if {option}`vim.treesitter.context.maxLines` is exceeded.";
type = types.enum ["inner" "outer"];
default = "outer";
};
@ -49,7 +49,7 @@ in {
};
separator = mkOption {
description = nvim.nmd.asciiDoc ''
description = ''
Separator between context and content. Should be a single character string, like '-'.
When separator is set, the context will only show up when there are at least 2 lines above cursorline.

2
modules/treesitter/treesitter.nix
View file

@ -19,7 +19,7 @@ with lib; {
grammars = mkOption {
type = with types; listOf package;
default = [];
description = nvim.nmd.asciiDoc ''
description = ''
List of treesitter grammars to install. For supported languages
use the `vim.language.<lang>.treesitter` option
'';

1
modules/ui/breadcrumbs/breadcrumbs.nix
View file

@ -305,6 +305,7 @@ in {
reorient = mkOption {
type = types.enum ["smart" "top" "mid" "none"];
default = "smart";
description = "reorient buffer after changing nodes";
};
scrolloff = mkOption {

6
modules/visuals/visuals.nix
View file

@ -80,8 +80,8 @@ in {
};
showEndOfLine = mkOption {
description = nvim.nmd.asciiDoc ''
Displays the end of line character set by <<opt-vim.visuals.indentBlankline.eolChar>> instead of the
description = ''
Displays the end of line character set by {option}`vim.visuals.indentBlankline.eolChar` instead of the
indent guide on line returns.
'';
type = types.bool;
@ -110,7 +110,7 @@ in {
highlightForCount = mkOption {
type = types.bool;
default = true;
description = nvim.nmd.literalAsciiDoc ''
description = ''
Enable support for highlighting when a <count> is provided before the key
If set to false it will only highlight when the mapping is not prefixed with a <count>
'';