Sublime Text

Installation

Basic configuration for the language server is provided through the LSP plugin

The server language executable can be overridden per project basis; refer to Sublime Text Projects documentation.

Alternatively, you can change the default command to launch the language sever with a particular interpreter

"clients": {
    "esbonio": {
        "enabled": true,
        "command": [
            "/path/to/virtualenv/bin/python",
            "-m",
            "esbonio"
        ],

Configuration

The language server’s configuration options are passed as initializationOptions during the server’s setup e.g.

{
    "clients": {
        "esbonio": {
            "enabled": true,
            "command": ["esbonio"],
            "selector": "text.restructuredtext",
            "initializationOptions": {
                "server": {
                    "logLevel": "debug"
                },
                "sphinx": {
                  "confDir": "/path/to/docs"
                  "srcDir": "${confDir}/../docs-src"
                }
            }
        }
    }
}

Here are all the options supported by the server.

Examples

To try the example configuration on your machine.

1. Ensure you have Package Control installed.

2. Install LSP package.

3. Open Command Palette and choose Preferences: LSP Settings

4. Copy the content of LSP.sublime-settings to the settings file.

Troubleshooting

Refer to the troubleshooting guide of LSP.