aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/server_configurations.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/server_configurations.md b/doc/server_configurations.md
index c0a2353e..35984f9b 100644
--- a/doc/server_configurations.md
+++ b/doc/server_configurations.md
@@ -31,6 +31,7 @@ that config.
- [ember](#ember)
- [emmet_ls](#emmet_ls)
- [erlangls](#erlangls)
+- [esbonio](#esbonio)
- [eslint](#eslint)
- [flow](#flow)
- [flux-lsp](#flux-lsp)
@@ -1224,6 +1225,74 @@ require'lspconfig'.erlangls.setup{}
```
+## esbonio
+
+https://github.com/swyddfa/esbonio
+
+Esbonio is a language server for [Sphinx](https://www.sphinx-doc.org/en/master/) documentation projects.
+The language server can be installed via pip
+
+```
+pip install esbonio
+```
+
+Since Sphinx is highly extensible you will get best results if you install the language server in the same
+Python environment as the one used to build your documentation. To ensure that the correct Python environment
+is picked up, you can either launch `nvim` with the correct environment activated.
+
+```
+source env/bin/activate
+nvim
+```
+
+Or you can modify the default `cmd` to include the full path to the Python interpreter.
+
+```lua
+require'lspconfig'.esbonio.setup {
+ cmd = { '/path/to/virtualenv/bin/python', '-m', 'esbonio' }
+}
+```
+
+Esbonio supports a number of config values passed as `init_options` on startup, for example.
+
+```lua
+require'lspconfig'.esbonio.setup {
+ init_options = {
+ server = {
+ logLevel = "debug"
+ },
+ sphinx = {
+ confDir = "/path/to/docs",
+ srcDir = "${confDir}/../docs-src"
+ }
+}
+```
+
+A full list and explanation of the available options can be found [here](https://swyddfa.github.io/esbonio/docs/lsp/editors/index.html)
+
+
+
+**Snippet to enable the language server:**
+```lua
+require'lspconfig'.esbonio.setup{}
+```
+
+**Commands and default values:**
+```lua
+ Commands:
+
+ Default Values:
+ cmd = { "python3", "-m", "esbonio" }
+ filetypes = { "rst" }
+ root_dir = function(path)
+ if M.path.is_dir(M.path.join(path, '.git')) then
+ return path
+ end
+ end)
+ end
+```
+
+
## eslint
https://github.com/hrsh7th/vscode-langservers-extracted