summaryrefslogtreecommitdiff
path: root/dot_config/nvim_new/lsp/esbonio.lua
diff options
context:
space:
mode:
authorIbrahim Muftee <ibrahim@muftee.net>2025-08-04 07:45:42 -0500
committerIbrahim Muftee <ibrahim@muftee.net>2026-07-01 00:23:31 -0400
commit23d53b5d7bc2f31eed672c0a8d26dc608fb6d0ba (patch)
tree7b23cd20340dd0984bb1a9616744ef81c69d3b4c /dot_config/nvim_new/lsp/esbonio.lua
parent1227ae992f4494d6a3d82d70d0bb9cb01dd50847 (diff)
feat(nvim) slim down new config
Diffstat (limited to 'dot_config/nvim_new/lsp/esbonio.lua')
-rw-r--r--dot_config/nvim_new/lsp/esbonio.lua49
1 files changed, 49 insertions, 0 deletions
diff --git a/dot_config/nvim_new/lsp/esbonio.lua b/dot_config/nvim_new/lsp/esbonio.lua
new file mode 100644
index 0000000..9069e78
--- /dev/null
+++ b/dot_config/nvim_new/lsp/esbonio.lua
@@ -0,0 +1,49 @@
+---@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)
+return {
+ cmd = { 'python3', '-m', 'esbonio' },
+ filetypes = { 'rst' },
+ root_markers = { '.git' },
+}