aboutsummaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authordundargoc <gocdundar@gmail.com>2024-05-22 16:07:45 +0200
committerdundargoc <33953936+dundargoc@users.noreply.github.com>2024-05-22 20:15:17 +0200
commite8f7025de1d8b7c8bbe747736e4c46dcd6e73133 (patch)
tree6dba4440bc8bef6a9a205b08e5ebb18e518a420f /scripts
parent339129ebc9503883a3f060d3eff620d67a9eadaf (diff)
downloadrneovim-e8f7025de1d8b7c8bbe747736e4c46dcd6e73133.tar.gz
rneovim-e8f7025de1d8b7c8bbe747736e4c46dcd6e73133.tar.bz2
rneovim-e8f7025de1d8b7c8bbe747736e4c46dcd6e73133.zip
docs: move vim.health documentation to lua.txt
`vim.health` is not a "plugin" but part of our Lua API and the documentation should reflect that. This also helps make the documentation maintenance easier as it is now generated.
Diffstat (limited to 'scripts')
-rw-r--r--scripts/gen_help_html.lua5
-rwxr-xr-xscripts/gen_vimdoc.lua2
2 files changed, 4 insertions, 3 deletions
diff --git a/scripts/gen_help_html.lua b/scripts/gen_help_html.lua
index b712cf1475..2a8f8308ac 100644
--- a/scripts/gen_help_html.lua
+++ b/scripts/gen_help_html.lua
@@ -75,7 +75,6 @@ local new_layout = {
['news-0.9.txt'] = true,
['news-0.10.txt'] = true,
['nvim.txt'] = true,
- ['pi_health.txt'] = true,
['provider.txt'] = true,
['ui.txt'] = true,
['vim_diff.txt'] = true,
@@ -1440,9 +1439,9 @@ function M.test_gen(help_dir)
help_dir,
tmpdir,
-- Because gen() is slow (~30s), this test is limited to a few files.
- { 'pi_health.txt', 'help.txt', 'index.txt', 'nvim.txt' }
+ { 'help.txt', 'index.txt', 'nvim.txt' }
)
- eq(4, #rv.helpfiles)
+ eq(3, #rv.helpfiles)
eq(0, rv.err_count, 'parse errors in :help docs')
eq({}, rv.invalid_links, 'invalid tags in :help docs')
end
diff --git a/scripts/gen_vimdoc.lua b/scripts/gen_vimdoc.lua
index 6d0fc46145..eea5688621 100755
--- a/scripts/gen_vimdoc.lua
+++ b/scripts/gen_vimdoc.lua
@@ -162,6 +162,7 @@ local config = {
'snippet.lua',
'text.lua',
'tohtml.lua',
+ 'health.lua',
},
files = {
'runtime/lua/vim/iter.lua',
@@ -181,6 +182,7 @@ local config = {
'runtime/lua/vim/snippet.lua',
'runtime/lua/vim/text.lua',
'runtime/lua/vim/glob.lua',
+ 'runtime/lua/vim/health.lua',
'runtime/lua/vim/_meta/builtin.lua',
'runtime/lua/vim/_meta/diff.lua',
'runtime/lua/vim/_meta/mpack.lua',