diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2024-10-24 17:24:01 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2024-10-24 17:38:57 +0200 |
| commit | b2c90502d8dd15efd2de24e1536952e0cb4bca16 (patch) | |
| tree | 60418f9ab3d1156b749c81aafb86d3b75578e049 /scripts | |
| parent | feat(docs): autogenerate default_config docs (diff) | |
| download | nvim-lspconfig-b2c90502d8dd15efd2de24e1536952e0cb4bca16.tar nvim-lspconfig-b2c90502d8dd15efd2de24e1536952e0cb4bca16.tar.gz nvim-lspconfig-b2c90502d8dd15efd2de24e1536952e0cb4bca16.tar.bz2 nvim-lspconfig-b2c90502d8dd15efd2de24e1536952e0cb4bca16.tar.lz nvim-lspconfig-b2c90502d8dd15efd2de24e1536952e0cb4bca16.tar.xz nvim-lspconfig-b2c90502d8dd15efd2de24e1536952e0cb4bca16.tar.zst nvim-lspconfig-b2c90502d8dd15efd2de24e1536952e0cb4bca16.zip | |
feat(docs): improve formatting of generated docs
Diffstat (limited to 'scripts')
| -rw-r--r-- | scripts/docgen.lua | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/scripts/docgen.lua b/scripts/docgen.lua index 22abc294..38b4fa3c 100644 --- a/scripts/docgen.lua +++ b/scripts/docgen.lua @@ -9,11 +9,6 @@ local function template(s, params) return (s:gsub('{{([^{}]+)}}', params)) end ---- "@/.../nvim-lspconfig/lua/lspconfig/util.lua" => "./util.lua" -local function relpath(p) - return p:gsub([=[.*[/\\]lua[/\\]lspconfig[/\\]]=], '') -end - local function map_list(t, func) local res = {} for i, v in ipairs(t) do @@ -140,15 +135,17 @@ local function make_lsp_sections() end, }) - params.default_values = make_section(2, '\n\n', { + params.default_values = make_section(2, '\n', { function() if not template_def.default_config then return end return make_section(0, '\n', { map_sorted(template_def.default_config, function(k, v) - if type(v) ~= 'function' then - return ('- `%s` :\n```lua\n%s\n```'):format(k, inspect(v)) + if type(v) == 'boolean' then + return ('- `%s` : `%s`'):format(k, v) + elseif type(v) ~= 'function' then + return ('- `%s` :\n ```lua\n%s\n ```'):format(k, indent(2, inspect(v))) end local file = assert(io.open(config_file, 'r')) @@ -163,7 +160,7 @@ local function make_lsp_sections() io.close(file) -- XXX: "../" because the path is outside of the doc/ dir. - return ('- `%s` source (use "gF" to visit): [../%s:%d](../%s#L%d)\n'):format( + return ('- `%s` source (use "gF" to visit): [../%s:%d](../%s#L%d)'):format( k, config_file, linenr, |
