esbonio
plugins.lsp.servers.esbonio.enable
Whether to enable https://github.com/swyddfa/esbonio
Esbonio is a language server for Sphinx 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.
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.
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 .
Type: boolean
Default:
false
Example:
true
Declared by:
plugins.lsp.servers.esbonio.package
The package to use for esbonio. Has no default, but can be set to null.
Type: null or package
Declared by:
plugins.lsp.servers.esbonio.autostart
Controls if the FileType
autocommand that launches a language server is created.
If false
, allows for deferring language servers until manually launched with
:LspStart
(|lspconfig-commands|).
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.lsp.servers.esbonio.cmd
A list where each entry corresponds to the blankspace delimited part of the command that launches the server.
The first entry is the binary used to run the language server. Additional entries are passed as arguments.
Type: null or (list of string)
Default:
null
Declared by:
plugins.lsp.servers.esbonio.extraOptions
Extra options for the esbonio language server.
Type: attribute set of anything
Default:
{ }
Declared by:
plugins.lsp.servers.esbonio.filetypes
Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.
Type: null or (list of string)
Default:
null
Declared by:
plugins.lsp.servers.esbonio.rootDir
A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.
Type: null or lua function string
Default:
null
Plugin default: "nil"
Declared by:
plugins.lsp.servers.esbonio.settings
The settings for this LSP.
Type: attribute set of anything
Default:
{ }
Example:
{
callback = {
__raw = ''
function()
print('nixvim')
end
'';
};
foo_bar = 42;
hostname = "localhost:8080";
}
Declared by: