aboutsummaryrefslogtreecommitdiffstats
path: root/scripts
diff options
context:
space:
mode:
authorMichael Lingelbach <m.j.lbach@gmail.com>2021-11-09 09:53:21 -0800
committerGitHub <noreply@github.com>2021-11-09 09:53:21 -0800
commit3d85ff447d8ff7091b600c982495b5d1c8b25bf3 (patch)
tree068a403904504ce445e54d85927f88e47149d5c5 /scripts
parentdocs: update CONFIG.md (diff)
downloadnvim-lspconfig-3d85ff447d8ff7091b600c982495b5d1c8b25bf3.tar
nvim-lspconfig-3d85ff447d8ff7091b600c982495b5d1c8b25bf3.tar.gz
nvim-lspconfig-3d85ff447d8ff7091b600c982495b5d1c8b25bf3.tar.bz2
nvim-lspconfig-3d85ff447d8ff7091b600c982495b5d1c8b25bf3.tar.lz
nvim-lspconfig-3d85ff447d8ff7091b600c982495b5d1c8b25bf3.tar.xz
nvim-lspconfig-3d85ff447d8ff7091b600c982495b5d1c8b25bf3.tar.zst
nvim-lspconfig-3d85ff447d8ff7091b600c982495b5d1c8b25bf3.zip
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
Diffstat (limited to 'scripts')
-rw-r--r--scripts/docgen.lua2
-rw-r--r--scripts/vimdocgen.lua28
2 files changed, 1 insertions, 29 deletions
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