blob: 3b1fcee2fa315734db38d467667139414880f36b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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' },
}
|