SphinxConfig params not being set when using Visual Studio Code Remote - SSH

[phaile2]

Expected behavior

When running on a code base on a remote machine, I'm seeing that the SphinxConfig seems to be empty in the logs (with the exception of cwd which seems to be auto generated). I wanted to check if remote development is fully supported, or if maybe there is something wrong with my setup (tested using esbonio-demo and the pre release vs code extension)

Actual behavior

SphinxConfig should be properly set

[alcarney]

I've never tried the extension over SSH before, but I have used it in other remote contexts like Dev Containers/Codespaces.

I am bit surprised you are only seeing the cwd being populated - unless we are thinking of different stages of the code! 😅
I would expect to see it at least trying to guess a reasonable sphinx-build command for your project. Is this the sort of thing you are seeing?

[esbonio.Configuration] SphinxConfig(enable_dev_tools=False, python_command=[], build_command=[], config_overrides={}, env_passthrough=[], cwd='/workspaces/develop/code', fallback_env='/workspaces/develop/.vscode/extensions/esbonio/bundled/env', python_path=[])
[esbonio.Configuration] Previous: None
[esbonio.Configuration] Current: SphinxConfig(enable_dev_tools=False, python_command=[], build_command=[], config_overrides={}, env_passthrough=[], cwd='/workspaces/develop/code', fallback_env='/workspaces/develop/.vscode/extensions/esbonio/bundled/env', python_path=[])
[esbonio.Configuration] ConfigChangeEvent(scope='file:///workspaces/develop/code', value=SphinxConfig(enable_dev_tools=False, python_command=[], build_command=[], config_overrides={}, env_passthrough=[], cwd='/workspaces/develop/code', fallback_env='/workspaces/develop/.vscode/extensions/esbonio/bundled/env', python_path=[]), previous=None)
[esbonio] Scheduled task: <Task pending name='Task-1130' coro=<SphinxManager._create_or_replace_client() running at /workspaces/develop/.vscode/extensions/esbonio/bundled/libs/esbonio/server/features/sphinx_manager/manager.py:309>>
[esbonio.SphinxManager] Using fallback environment
[esbonio.SphinxManager] Trying path: /workspaces/develop/code/changes
[esbonio.SphinxManager] Trying path: /workspaces/develop/code
[esbonio.SphinxManager] Trying path: /workspaces/develop
[esbonio.SphinxManager] Trying path: /workspaces
[esbonio.SphinxManager] Trying path: /
[esbonio.SphinxManager] Trying path: /
[esbonio] Task finished: <Task finished name='Task-1130' coro=<SphinxManager._create_or_replace_client() done, defined at /workspaces/develop/.vscode/extensions/esbonio/bundled/libs/esbonio/server/features/sphinx_manager/manager.py:309> result=None>
[esbonio.ProjectManager] No applicable project for uri: file:///workspaces/develop/code/changes/935.enhancement.md

One thing that is worth checking, is making sure that you are not being bitten by #813.
TLDR: If `pathlib.Path('/path/to/your/project/).resolve() != '/path/to/your/project', it's currently impossible to apply any configuration options to the server :/

It's hard to diagnose this kind of thing without any logs, so if you are able to share some that would be great.

[alcarney]

Just tried v0.96.0 of the extension over SSH to my Raspberry Pi and it appears to work ok, hopefully we just need to set a few configuration options to get it to work for you 🤞

[phaile2]

Thank you!

One thing that is worth checking, is making sure that you are not being bitten by #813.

This seemed to be the problem. Opening the workspace using the real path instead of the symlink fixed my issue