From 3d85ff447d8ff7091b600c982495b5d1c8b25bf3 Mon Sep 17 00:00:00 2001 From: Michael Lingelbach Date: Tue, 9 Nov 2021 09:53:21 -0800 Subject: docs: documentation overhaul (#1384) * remove automated generation of vimdoc + ci * unify ADVANCED_README.md and vimdoc * rename CONFIGS.md to server_configurations.md, move into doc folder * move CONTRIBUTING.md to .github folder --- scripts/docgen.lua | 2 +- scripts/vimdocgen.lua | 28 ---------------------------- 2 files changed, 1 insertion(+), 29 deletions(-) delete mode 100644 scripts/vimdocgen.lua (limited to 'scripts') diff --git a/scripts/docgen.lua b/scripts/docgen.lua index eae6278a..b5682e83 100644 --- a/scripts/docgen.lua +++ b/scripts/docgen.lua @@ -272,7 +272,7 @@ local function generate_readme(template_file, params) local input_template = readfile(template_file) local readme_data = template(input_template, params) - local writer = io.open('CONFIG.md', 'w') + local writer = io.open('doc/server_configurations.md', 'w') writer:write(readme_data) writer:close() end diff --git a/scripts/vimdocgen.lua b/scripts/vimdocgen.lua deleted file mode 100644 index 6bfa0dd8..00000000 --- a/scripts/vimdocgen.lua +++ /dev/null @@ -1,28 +0,0 @@ -local docgen = require 'babelfish' - -local docs = {} - -docs.generate = function() - local metadata = { - input_file = './README.md', - output_file = './doc/lspconfig.txt', - project_name = 'lspconfig', - header_aliases = { - ['Example: using the defaults'] = { 'Defaults', 'defaults' }, - ['Example: override some defaults'] = { 'Overriding server defaults', 'override-server-defaults' }, - ['Example: custom config'] = { 'Custom config', 'custom-config' }, - ['Example: override default config for all servers'] = { 'Overriding all defaults', 'override-all-defaults' }, - ['Individual server settings and initialization options'] = { - 'Per-server documentation', - 'server-documentation', - }, - ['Keybindings and completion'] = { 'Keybindings', 'keybindings' }, - ['Manually starting (or restarting) language servers'] = { 'Manual control', 'manual-control' }, - }, - } - docgen.generate_readme(metadata) -end - -docs.generate() - -return docs -- cgit v1.2.3-70-g09d2