Unable to launch server

[Jacob-Stevens-Haas]

Expected behavior

Able to preview rst files when running "Esbonio: Preview Documentation"

Actual behavior

"Esbonio Preview" editor opens, but is empty.

Log output

[client] Unable to resolve command lsp-devtools: Error: Command failed: command -v lsp-devtools
[client] Using user configured Python: ~/github/esbonio/bin/python
[client] Server start command: ~/github/esbonio/bin/python -S -m esbonio
[client] LanguageClientOptions: {
  "documentSelector": [
    {
      "scheme": "file",
      "language": "restructuredtext"
    },
    {
      "scheme": "file",
      "language": "markdown"
    }
  ],
  "outputChannel": {
    "name": "Esbonio"
  },
  "connectionOptions": {
    "maxRestartCount": 0
  },
  "initializationOptions": {
    "sphinx": {
      "fallbackEnv": "/home/jake/.vscode/extensions/swyddfa.esbonio-0.96.4/bundled/env"
    }
  },
  "middleware": {
    "workspace": {},
    "window": {}
  }
}
[client] Starting Language Server
[Error - 16:39:59] Esbonio Language Server client: couldn't create connection to server.
Launching server using command ~/github/esbonio/bin/python failed. Error: spawn ~/github/esbonio/bin/python ENOENT
[client] Launching server using command ~/github/esbonio/bin/python failed. Error: spawn ~/github/esbonio/bin/python ENOENT

(Optional) Settings from conf.py

N/A

Additional troubleshooting

Trying to start the server manually using the command from the logs results in

(esbonio) user@domain:~$ python -S -m esbonio
/home/jake/github/esbonio/bin/python: No module named esbonio.__main__; 'esbonio' is a package and cannot be directly executed

Esbonio 0.96.4, vscode 1.100.2 (Ubuntu).
Language server: esbonio v0.16.5, python 3.11.9

[alcarney]

Unfortunately, I don't fully understand what might be going on here yet...

Trying to start the server manually using the command from the logs results in

(esbonio) user@domain:~$ python -S -m esbonio
/home/jake/github/esbonio/bin/python: No module named esbonio.__main__; > 'esbonio' is a package and cannot be directly executed

I wouldn't expect that command to work for you as the -S flag disables the site-packages/ folder of the Python environment. It's used by the VSCode extension so that it can take any Python interpreter it finds and point it (using the PYTHONPATH environment variable) at the installation of the esbonio package that is bundled with the extension.

However, that's not the error message I would expect to see... since -S disables site-packages/, I would expect it to not find the esbonio package at all. For example, here is what I get when I try it on my machine

$ cd /tmp
/tmp $ python -m venv test-env
/tmp $ ./test-env/bin/activate
(test-env) /tmp $ pip install esbonio
(test-env) /tmp $ python -S -m esbonio
/tmp/test-env/bin/python: No module named esbonio

Esbonio 0.96.4, vscode 1.100.2 (Ubuntu).
Language server: esbonio v0.16.5, python 3.11.9

Versions v0.90+ of the VSCode extension bundle the beta releases of the 1.0 version of the esbonio Python package, so I wonder if the fact you have v0.16.5 installed it's conflicting... that may also explain the server.logLevel vs logging.level confusion in your comments on the other threads.

Sorry, I've mostly been thinking aloud so far! 😅
I would suggest trying the following

• Remove the installation of esbonio v0.16.5 from your esbonio environment
• Remove your esbonio.server.pythonPath setting and allow the extension to discover a Python interpreter via the Python extension.
• If the esbonio virtual environment contains Sphinx and the other dependencies you need for your docs, set the esbonio.sphinx.pythonCommand option, either through VSCode or in a pyproject.toml file - see here for more info

Hope that helps! 🤞