1 files changed, 51 insertions, 0 deletions
diff --git a/.config/nvim/lsp/esbonio.lua b/.config/nvim/lsp/esbonio.lua
new file mode 100644
index 0000000..3b1fcee
--- /dev/null
+++ b/.config/nvim/lsp/esbonio.lua
@@ -0,0 +1,51 @@
+---@brief
+---
+--- 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
+--- vim.lsp.config('esbonio', {
+---   cmd = { '/path/to/virtualenv/bin/python', '-m', 'esbonio' }
+--- })
+--- ```
+---
+--- Esbonio supports a number of config values passed as `init_options` on startup, for example.
+---
+--- ```lua
+--- vim.lsp.config('esbonio', {
+---   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://docs.esbon.io/en/esbonio-language-server-v0.16.4/lsp/getting-started.html?editor=neovim-lspconfig#configuration)
+
+---@type vim.lsp.Config
+return {
+  cmd = { 'python3', '-m', 'esbonio' },
+  filetypes = { 'rst' },
+  root_markers = { '.git' },
+}