Esbonio VSCode Extension v0.9.0 - 2022-05-22

v0.9.0 - 2022-05-22

Features

• Add new esbonio.sphinx.copyBuildCommand and esbonio.sphinx.setBuildCommand commands. As the name suggests, the first command will copy the equivalent sphinx-build command to the clipboard while the set build command prompts for a set of sphinx-build arguments and updates the server's configuration accordingly. (#360)

Deprecated

• The esbonio.server.hideSphinxOutput option has been deprecated in favour of the new esbonio.sphinx.quiet and esbonio.sphinx.silent options. It will be removed when the server reaches v1.0 (#360)

Misc

• The esbonio.sphinx.numJobs configuration now defaults to 1 in line with sphinx-build defaults. (#374)

Esbonio Language Server v0.12.0 - 2022-05-22

v0.12.0 - 2022-05-22

Features

• The language server now supports many (but not all) sphinx-build command line options. The sphinx.* section of the server's initialization options has been extened to include the following options.

  • configOverrides
  • doctreeDir
  • keepGoing
  • makeMode
  • quiet
  • silent
  • tags
  • verbosity
  • warningIsError

  See the documentation for details.

  Additionally, a new cli application esbonio-sphinx is now available which language clients (or users) can use to convert sphinx-build cli options to/from the server's initialization options. (#360)

Enhancements

• textDocument/documentSymbol responses now include symbol information on directives. (#374)

Fixes

• .. include:: directives no longer break goto definition for :ref: role targets (#361)

API Changes

• Add method get_initial_doctree to RstLanguageServer which can be used to obtain a doctree of the given file before any role and directives have been applied. (#374)

Misc

• The esbonio.sphinx.numJobs configuration now defaults to 1 in line with sphinx-build defaults. (#374)

Esbonio Language Server v0.11.2 - 2022-05-09

v0.11.2 - 2022-05-09

Enhancements

• Add esbonio.lsp.rst._record and esbonio.lsp.sphinx._record startup modules. These can be used to record all LSP client-sever communication to a text file. (#380)

Fixes

• The language server now detects functionality bundled with standard Sphinx extensions (#381)

Esbonio Language Server v0.11.1 - 2022-04-26

v0.11.1 - 2022-04-26

Fixes

• textDocument/documentLink requests no longer fail when encountering :: characters in C++ references. (#377)

Esbonio VSCode Extension v0.8.3 - 2022-04-20

v0.8.3 - 2022-04-20

Misc

• Switch from vscode-test to @vscode/test-electron (#372)

---

v0.8.2 - 2022-04-18

Devops was down, preventing 0.8.2 from being released properly so the above release also includes the following changes

Enhancements

• Added the esbonio.sphinx.forceFullBuild option (default: true) which can be used to control if the language server forces a full Sphinx build on startup. (#358)
• Added the esbonio.sphinx.numJobs option (default: auto) which can be used to control the number of parallel jobs used by Sphinx. (#359)

Esbonio Language Server v0.11.0 - 2022-04-18

v0.11.0 - 2022-04-18

Features

• Add textDocument/documentLink support.

  The server supports resolving links for role targets with initial support for intersphinx references and local :doc: references.

  The server also supports resolving links for directive arguments with initial support for .. image::, .. figure::, .. include:: and .. literalinclude:: directives. (#294)

Enhancements

• Language clients can now control if the server forces a full build of a Sphinx project on startup by providing a sphinx.forceFullBuild initialization option, which defaults to true (#358)

• Language clients can now control the number of parallel jobs by providing a sphinx.numJobs initialization option, which defaults to auto. Clients can disable parallel builds by setting this option to 1 (#359)

Fixes

• Goto definition for :ref: targets now works for labels containing - characters (#357)
• Goto definition for :doc: targets will now only return a result if the referenced document actually exists. (#369)

Esbonio Language Server v0.10.3 - 2022-04-07

v0.10.3 - 2022-04-07

Fixes

• A client's capabilities is now respected when constructing CompletionItems (#270)
• Instead of spamming the client with notifications, the language server now reports Sphinx config/build errors as diagnostics. (#315)
• Previews should now work on MacOS (#341)
• Running $ esbonio directly on the command line now correctly starts the server again (#346)
• The language server should no longer fail when suggesting completions for directives that are not class based. e.g. DirectiveContainer based directives from the breathe extension. (#353)

Esbonio VSCode Extension v0.8.1 - 2022-03-22

v0.8.1 - 2022-03-22

Fixes

• Fix handling of Windows URIs in preview code. (#340)

Esbonio Language Server v0.10.2 - 2022-03-22

v0.10.2 - 2022-03-22

Fixes

• Previews on Windows should now start correctly (#341)

Esbonio Language Server v0.10.1 - 2022-03-20

v0.10.1 - 2022-03-20

Fixes

• The language server should now correctly handle buildDir, confDir and srcDir config values containing paths relative to ~ (#342)