Esbonio VSCode Extension v1.0.0 - 2025-10-28

v1.0.0 - 2025-10-28

Enhancements

• esbonio.sphinx.pythonCommand is now an object with with following fields

  • command: This list of strings from the original esbonio.sphinx.pythonCommand.
  • env: A dictionary allowing you to add/override environment variables passed to the sphinx process
  • cwd: A string allowing you to change the directory in which the sphinx process is launched.

  (#1024)

Misc

• The following options have been removed

  • esbonio.sphinx.envPassthrough: For ages now, the language server passes through all environment variables to the sphinx process so this option has no use.
  • esbonio.sphinx.pythonPath: The original intent behind this option was to allow you to override the version of the sphinx agent. However, the better way to do this is just use a different version of esbonio.
  • esbonio.sphinx.cwd: Use esbonio.sphinx.pythonCommand.cwd

  (#1027)

• Drop Python 3.9 support (#1032)

Esbonio Language Server v1.0.0 - 2025-10-28

v1.0.0 - 2025-10-28

Enhancements

• Add the esbonio.sphinx.pythonCommand.env option which can be used to set/override envrionment variables for the Sphinx process (#469)

• esbonio.sphinx.pythonCommand is now an object with with following fields

  • [esbonio.sphinx.pythonCommand.]command: This list of strings from the original esbonio.sphinx.pythonCommand.
  • [esbonio.sphinx.pythonCommand.]env: A dictionary allowing you to add/override environment variables passed to the sphinx process
  • [esbonio.sphinx.pythonCommand.]cwd: A string allowing you to change the directory in which the sphinx process is launched.

  95% of the time, the previous simple list of strings was sufficient to configure the process.
  So the server will still accept a list of strings for esbonio.sphinx.pythonCommand and it will be automatically converted to the new object representation.

  The server now treats initializationOptions as the lowest priority settings source, allowing clients to use them to provide fallback options.

  (#1024)

• If there is no pythonCommand configured, esbonio will now attempt to use the server's runtime environment as a fallback. (#1027)

Fixes

• Passing the -C flag to esbonio.sphinx.buildCommand now works as expected (#997)

Docs

• Add guide on using the -C flag to sphinx-build to allow the use of esbonio with files that aren't in a Sphinx project. (#997)

Misc

• The following options have been removed

  • esbonio.sphinx.envPassthrough: For ages now, the language server passes through all environment variables to the sphinx process so this option has no use.
  • esbonio.sphinx.pythonPath: The original intent behind this option was to allow you to override the version of the sphinx agent. However, the better way to do this is just use a different version of esbonio.
  • esbonio.sphinx.cwd: Use esbonio.sphinx.pythonCommand.cwd
  • esbonio.sphinx.fallbackEnv: This was a hack to allow the VSCode extension to provide a default environment in the absence of any user configuration, client's should set esbonio.sphinx.pythonCommand in their initializationOptions.

  (#1024)

• Drop Python 3.9 support (#1032)

Esbonio VSCode Extension v0.96.6 - 2025-07-07

v0.96.6 - 2025-07-07

Misc

• Actually update esbonio to v1.0b12 (#1014)

Esbonio VSCode Extension v0.96.5 - 2025-07-03

v0.96.5 - 2025-07-03

Enhancements

• If there is not already a server running and the user changes their Python env, the extension will automatically try to start the server.
  This should make recovering from a missing Python interpreter easier (#988)
• Remove border around the preview pane's <iframe> by @qwertychouskie (#999)

Fixes

• The extension no longer silently does nothing if it cannot locate a compatible Python interpreter.
  Instead it uses an error notification to inform the user and given them the option of selecting an interpreter via the Python extension. (#988)

Misc

• Update esbonio to 1.0b12 (#1009)

Esbonio Language Server v1.0.0b12 - 2025-07-03

v1.0.0b12 - 2025-07-03

Features

• Re-implement support for hover requests, where the hover reveals the documentation behind cross-references like :class:`HoverContext` (#1008)

Fixes

• Rather than trying to generate unique urls across projects (which broke many links), the preview server now sets the Cache-Control header in an attempt to ensure the preview always updates correctly. (#951, #987)
• The sphinx agent no longer crashes when saving a configuration value that is a list containing exactly three items (#969)
• Improve diagnostic experience in editors like neovim which do not support workspace/diagnostic/refresh requests (#998)

Misc

• Update to pygls v2.0.0a4

  Add support for Python 3.14 (#1007)

Esbonio VSCode Extension v0.96.4 - 2025-04-02

v0.96.4 - 2025-04-02

Enhancements

• Expose esbonio.preview.synchronizeScroll setting.

  Add interactive esbonio.preview.setScrollingBehavior command to easily switch between valid options. (#979)

Misc

• Update bundlded version of the language server to 1.0.0b11 (#983)

Esbonio Language Server v1.0.0b11 - 2025-04-02

v1.0.0b11 - 2025-04-02

Features

• Re-implement textDocument/definition support (#978)

Enhancements

• Introduce esbonio.preview.synchronizeScroll setting (#979)

Fixes

• The webview should now automatically reconnect with the server when the connection is lost. (#646)
• Previews should no longer fail to update when switching between projects that produce identical output filenames (#951)
• Fix ${defaultBuildDir} expansion for recent Sphinx versions (#970)

Esbonio VSCode Extension v0.96.3 - 2025-02-22

v0.96.3 - 2025-02-22

Fixes

• Add missing exceptiongroup package (#965)

Esbonio VSCode Extension v0.96.2 - 2025-02-08

v0.96.2 - 2025-02-08

Misc

• Change the default logging level to info

  Update bundled version of the language server to 1.0.0b10 (#964)

Esbonio Language Server v1.0.0b10 - 2025-02-08

v1.0.0b10 - 2025-02-08

Features

• textDocument/documentLink requests are once again supported for the following roles are directives

  • .. image::
  • .. figure::
  • .. include::
  • .. literainclude::
  • :download:
  • :doc:
  • All :external:* roles (i.e. intersphinx references)

  Both reStructuredText and MyST syntax is supported.

  (#956)

Enhancements

• Filepath completion suggestions are now provided for the :download: role (#956)

Fixes

• The preview should no longer lose its scroll state when reloading a page that was opened at a specific anchor tag (e.g. #heading-name) (#788)
• The server should now ensure that all window/workDoneProgress tokens are cleaned up (#802)
• The configuration system should now produce a lot less log noise (#904)
• The sphinx agent will now directly inject the webview.js script into the page alongside the line number markers.
  This means features like synchronised scrolling should continue to work, even if the current theme ignores the JS files provided by Sphinx. (#942)
• When expanding the ${venv} config variable, the server should no longer accidentally follow symlinks back to the base Python installation (#945)