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](https://github.com/swyddfa/esbonio/issues/358))
- Added the `esbonio.sphinx.numJobs` option (default: `auto`) which can be used to control the number of parallel jobs used by Sphinx. ([359](https://github.com/swyddfa/esbonio/issues/359))
esbonio-language-server-v0.11.0
<h1 class="title">v0.11.0 - 2022-04-18</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul>
<li><p class="first">Add <tt class="docutils literal">textDocument/documentLink</tt> support.</p>
<p>The server supports resolving links for role targets with initial support for intersphinx references and local <tt class="docutils literal">:doc:</tt> references.</p>
<p>The server also supports resolving links for directive arguments with initial support for <tt class="docutils literal">.. image::</tt>, <tt class="docutils literal">.. figure::</tt>, <tt class="docutils literal">.. include::</tt> and <tt class="docutils literal">.. literalinclude::</tt> directives. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/294">#294</a>)</p>
</li>
</ul>
</div>
<div class="section" id="enhancements">
<h1>Enhancements</h1>
<ul>
<li><p class="first">Language clients can now control if the server forces a full build of a Sphinx project on startup by providing a <tt>sphinx.forceFullBuild</tt> initialization option, which defaults to <tt>true</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/358">#358</a>)</p>
</li>
<li><p class="first">Language clients can now control the number of parallel jobs by providing a <tt>sphinx.numJobs</tt> initialization option, which defaults to <tt>auto</tt>. Clients can disable parallel builds by setting this option to <tt>1</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/359">#359</a>)</p>
</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Goto definition for <tt class="docutils literal">:ref:</tt> targets now works for labels containing <tt class="docutils literal">-</tt> characters (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/357">#357</a>)</li>
<li>Goto definition for <tt class="docutils literal">:doc:</tt> targets will now only return a result if the referenced document actually exists. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/369">#369</a>)</li>
</ul>
</div>
esbonio-language-server-v0.10.3
<h1 class="title">v0.10.3 - 2022-04-07</h1>
<h2 class="subtitle" id="fixes">Fixes</h2>
<ul class="simple">
<li>A client's capabilities is now respected when constructing <tt class="docutils literal">CompletionItems</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/270">#270</a>)</li>
<li>Instead of spamming the client with notifications, the language server now reports Sphinx config/build errors as diagnostics. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/315">#315</a>)</li>
<li>Previews should now work on MacOS (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/341">#341</a>)</li>
<li>Running <tt class="docutils literal">$ esbonio</tt> directly on the command line now correctly starts the server again (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/346">#346</a>)</li>
<li>The language server should no longer fail when suggesting completions for directives that are not class based.
e.g. <tt class="docutils literal">DirectiveContainer</tt> based directives from the <tt class="docutils literal">breathe</tt> extension. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/353">#353</a>)</li>
</ul>
esbonio-vscode-extension-v0.8.1
<h1 class="title">v0.8.1 - 2022-03-22</h1>
<h2 class="subtitle" id="fixes">Fixes</h2>
<ul class="simple">
<li>Fix handling of Windows URIs in preview code. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/340">#340</a>)</li>
</ul>
esbonio-language-server-v0.10.2
<h1 class="title">v0.10.2 - 2022-03-22</h1>
<h2 class="subtitle" id="fixes">Fixes</h2>
<ul class="simple">
<li>Previews on Windows should now start correctly (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/341">#341</a>)</li>
</ul>
esbonio-language-server-v0.10.1
<h1 class="title">v0.10.1 - 2022-03-20</h1>
<h2 class="subtitle" id="fixes">Fixes</h2>
<ul class="simple">
<li>The language server should now correctly handle <tt class="docutils literal">buildDir</tt>, <tt class="docutils literal">confDir</tt> and <tt class="docutils literal">srcDir</tt> config values containing paths relative to <tt class="docutils literal">~</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/342">#342</a>)</li>
</ul>
esbonio-vscode-extension-v0.8.0
<h1 class="title">v0.8.0 - 2022-03-17</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul>
<li><p class="first">Add commands <tt class="docutils literal">esbonio.sphinx.selectConfDir</tt>, <tt class="docutils literal">esbonio.sphinx.selectSrcDir</tt>, <tt class="docutils literal">esbonio.sphinx.selectBuildDir</tt>
which allow the user to interactively select values for the <tt class="docutils literal">esbonio.sphinx.confDir</tt>, <tt class="docutils literal">esbonio.sphinx.srcDir</tt>, <tt class="docutils literal">esbonio.sphinx.buildDir</tt>
options.</p>
<p>The commands can be triggered through the command palette or the language status items. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/337">#337</a>)</p>
</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Language status items now correctly remove the errored status when an issue is resolved. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/329">#329</a>)</li>
</ul>
</div>
<div class="section" id="enhancements">
<h1>Enhancements</h1>
<ul class="simple">
<li>Switched to an <tt class="docutils literal"><iframe></tt> based approach for previews, which should improve compatability with various Sphinx themes. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/275">#275</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>Renamed the <tt class="docutils literal">esbonio.server.entryPoint</tt> configuration option to <tt class="docutils literal">esbonio.server.startupModule</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/337">#337</a>)</li>
</ul>
</div>
<div class="section" id="removed">
<h1>Removed</h1>
<ul class="simple">
<li>The editor commands <tt class="docutils literal">esbonio.insert.link</tt> and <tt class="docutils literal">esbonio.insert.inlineLink</tt> have been removed.
They are however available in the <a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext">reStructuredText</a> extension. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/307">#307</a>)</li>
</ul>
</div>
esbonio-language-server-v0.10.0
<h1 class="title">v0.10.0 - 2022-03-17</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>The server now provides an <cite>esbonio.server.preview</cite> command that can be used to preview HTML Sphinx projects via a local HTTP server. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/275">#275</a>)</li>
<li>The language server now accepts paths relative to <tt class="docutils literal">${workspaceFolder}</tt> for Sphinx's <tt class="docutils literal">confDir</tt>, <tt class="docutils literal">srcDir</tt> and <tt class="docutils literal">builDir</tt> options. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/304">#304</a>)</li>
<li>The language server now supports <tt class="docutils literal">textDocument/definition</tt> requests for <tt class="docutils literal">.. image::</tt> directive arguments. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/318">#318</a>)</li>
<li>The language server now supports <tt class="docutils literal">textDocument/definition</tt> requests for <tt class="docutils literal">.. figure::</tt> directive arguments. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/319">#319</a>)</li>
<li>The language server will now look in sphinx extension modules and <tt class="docutils literal">conf.py</tt> files for extensions to the language server. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/331">#331</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>The language server no longer crashes when asked to <tt class="docutils literal"><span class="pre">--exclude</span></tt> a module that would not be loaded anyway. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/313">#313</a>)</li>
<li>Completion suggestions for domain objects referenced by roles such as <tt class="docutils literal">:doc:</tt>, <tt class="docutils literal">:ref:</tt>, <tt class="docutils literal">:func:</tt> and many more now correctly update each time a rebuild is triggered. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/317">#317</a>)</li>
<li>Goto definition on a directive's arguments is no longer foiled by trailing whitespace. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/327">#327</a>)</li>
</ul>
</div>
esbonio-vscode-extension-v0.7.3
<h1 class="title">v0.7.3 - 2022-03-07</h1>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Duplicate output channels are no longer created in the event of a language server crash. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/287">#287</a>)</li>
<li>Changes to <tt class="docutils literal">esbonio.server.logLevel</tt> no longer require VSCode to be restarted to take effect client side. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/301">#301</a>)</li>
<li>Options such as <tt class="docutils literal">esboino.server.logLevel</tt> can now be set on a per-project basis. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/302">#302</a>)</li>
</ul>
</div>
<div class="section" id="enhancements">
<h1>Enhancements</h1>
<ul class="simple">
<li>The status bar has been re-implemented as a collection of language status items. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/240">#240</a>)</li>
<li>The server can now be restarted by clicking on the relevant language status item (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/241">#241</a>)</li>
<li>Add option <tt class="docutils literal">esbonio.server.enabledInPyFiles</tt> which allows the user to disable the language server in Python files. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/285">#285</a>)</li>
<li>All extension log output has been unified into a single output channel. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/287">#287</a>)</li>
<li>Add option <tt class="docutils literal">esbonio.server.entryPoint</tt> which allows the user to set an entry point.
Also add options <tt class="docutils literal">esbonio.server.includedModules</tt> and <tt class="docutils literal">esbonio.server.excludedModules</tt> to allow the user to control which modules are loaded in the server configuration. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/288">#288</a>)</li>
<li>The <tt class="docutils literal">esbonio.server.pythonPath</tt> configuration option now supports paths relative to <tt class="docutils literal">${workspaceRoot}</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/300">#300</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>Add soft dependency on <a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=trond-snekvik.simple-rst">trond-snekvik.simple-rst</a> in favour of using bespoke grammar rules. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/279">#279</a>)</li>
<li>This extension now requires the Esbonio language server version to be <tt class="docutils literal">>= 0.9.0</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/308">#308</a>)</li>
</ul>
</div>
esbonio-language-server-v0.9.0
<h1 class="title">v0.9.0 - 2022-03-07</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>The language server now supports providing documentation on roles, directives (and their options).
Note however, this requires the relevant documentation to be explicitly added to the relevant <tt class="docutils literal">LanguageFeatures</tt>. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/36">#36</a>)</li>
<li>The server now listens for <tt class="docutils literal">workspace/didDeleteFiles</tt> notifications. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/93">#93</a>)</li>
<li>Add experimental spell checking support. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/271">#271</a>)</li>
<li>The language server now provides completion suggestions for <tt class="docutils literal">.. <span class="pre">code-block::</span></tt> and <tt class="docutils literal">.. highlight::</tt> language names. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/273">#273</a>)</li>
<li>The language server now supports <tt class="docutils literal">completionItem/resolve</tt> requests, it is currently implemented for roles, directives and directive options. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/274">#274</a>)</li>
<li>The language server now supports <tt class="docutils literal">textDocument/definition</tt> requests for <tt class="docutils literal">.. include::</tt> directive arguments. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/276">#276</a>)</li>
<li>The language server now supports <tt class="docutils literal">textDocument/definition</tt> requests for <tt class="docutils literal">.. literalinclude::</tt> directive arguments. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/277">#277</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Diagnostics are now cleared for deleted files. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/291">#291</a>)</li>
</ul>
</div>
esbonio-vscode-extension-v0.7.2
<h1 class="title">v0.7.2 - 2021-11-26</h1>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Simplified highlighting of footnote references to prevent edge cases from
effectively disabling highlighting of a document. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/252">#252</a>)</li>
<li>Literal block markers no longer disable highlighting of any preceeding content. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/254">#254</a>)</li>
<li>Code blocks that have injected grammars (e.g. python code blocks) now correctly highlight any options
on the directive (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/255">#255</a>)</li>
</ul>
</div>
<div class="section" id="enhancements">
<h1>Enhancements</h1>
<ul class="simple">
<li>Add <tt class="docutils literal">esbonio.server.enabled</tt> option which gives the user the ability to disable the language sever if they wish. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/239">#239</a>)</li>
<li>Code blocks that contain a language that's not recognised, are now highlighted as strings. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/253">#253</a>)</li>
<li>Add <tt class="docutils literal">esbonio.sphinx.buildDir</tt> option which allows the user to specify where Sphinx's build files get written to. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/258">#258</a>)</li>
</ul>
</div>
esbonio-sphinx-extensions-v0.1.0
<h1 class="title">v0.1.0 - 2021-11-26</h1>
<h2 class="subtitle" id="features">Features</h2>
<ul class="simple">
<li>Add initial implementation of the <tt class="docutils literal">esbonio.tutorial</tt> extension. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/261">#261</a>)</li>
</ul>
esbonio-language-server-v0.8.0
<h1 class="title">v0.8.0 - 2021-11-26</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>The language server now respects the project's <tt class="docutils literal">default_role</tt> setting. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/72">#72</a>)</li>
<li>Initial implementation of the <tt class="docutils literal">textDocument/documentSymbols</tt> request which for example, powers the "Outline" view in VSCode.
Currently only section headers are returned. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/242">#242</a>)</li>
<li>The <tt class="docutils literal">esbonio.sphinx.buildDir</tt> option now supports <tt class="docutils literal">${workspaceRoot}</tt> and <tt class="docutils literal">${confDir}</tt> variable expansions (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/259">#259</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Role target <tt class="docutils literal">CompletionItems</tt> now preserve additional cross reference modifiers like <tt class="docutils literal">!</tt> and <tt class="docutils literal">~</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/211">#211</a>)</li>
<li>Intersphinx projects are now only suggested if they contain targets relevant to the current role. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/244">#244</a>)</li>
<li>Variables are now properly substituted in diagnostic messages. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/246">#246</a>)</li>
</ul>
</div>
esbonio-vscode-extension-v0.7.1
<h1 class="title">v0.7.1 - 2021-09-13</h1>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Fix handling of <tt class="docutils literal"><script></tt> tags without a <tt class="docutils literal">src</tt> attribute when generating the
HTML preview of a page. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/214">#214</a>)</li>
</ul>
</div>
<div class="section" id="enhancements">
<h1>Enhancements</h1>
<ul class="simple">
<li>When the user is using an environment with an incompatible Python version but have
the Python extension available, they are given the option of picking a new environment to use. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/176">#176</a>)</li>
<li>When the user is prompted to install the language server in the current environment,
they now also have the option of picking a new environment to use instead. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/224">#224</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>This extension does not support untrusted workspaces. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/217">#217</a>)</li>
</ul>
</div>
esbonio-language-server-v0.7.0
<h1 class="title">v0.7.0 - 2021-09-13</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>Add initial goto definition support.
Currently only support definitions for <tt class="docutils literal">:ref:</tt> and <tt class="docutils literal">:doc:</tt> role targets. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/209">#209</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Completion suggestions for <tt class="docutils literal">:option:</tt> targets now insert text in the correct format (<tt class="docutils literal"><progname> <option></tt>) (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/212">#212</a>)</li>
<li>Diagnostics are now correctly cleared on Windows (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/213">#213</a>)</li>
<li>Completion suggestions are no longer given in the middle of Python code. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/215">#215</a>)</li>
<li><tt class="docutils literal">CompletionItems</tt> should no longer corrupt existing text when selected. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/223">#223</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>Updated <tt class="docutils literal">pygls</tt> to <tt class="docutils literal">v0.11.0</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/218">#218</a>)</li>
</ul>
</div>
esbonio-vscode-extension-v0.7.0
<h1 class="title">v0.7.0 - 2021-06-05</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>Add the ability to preview the output from the <tt class="docutils literal">html</tt> builder.` (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/190">#190</a>)</li>
<li>Add a statusbar item that indicates the state of the language server. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/194">#194</a>)</li>
<li>VSCode will now syntax highlight C, C++, Javascript and Typescript code blocks (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/205">#205</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Fix incorrect syntax highlighting of multiple links on a single line (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/203">#203</a>)</li>
<li>VSCode now treats <tt class="docutils literal">*</tt> characters as quotes, meaning selecting some text and entering
a <tt class="docutils literal">*</tt> will automatically surround that text rather than replacing it. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/204">#204</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>The cli arguments <tt class="docutils literal"><span class="pre">--cache-dir</span></tt>, <tt class="docutils literal"><span class="pre">--log-filter</span></tt>, <tt class="docutils literal"><span class="pre">--log-level</span></tt> and
<tt class="docutils literal"><span class="pre">--hide-sphinx-output</span></tt> have been replaced with the configuration
parameters <tt class="docutils literal">esbonio.sphinx.buildDir</tt>, <tt class="docutils literal">esbonio.server.logFilter</tt>,
<tt class="docutils literal">esbonio.logLevel</tt> and <tt class="docutils literal">esbonio.server.hideSphinxOutput</tt> respectively (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/185">#185</a>)</li>
<li>The language server's startup sequence has been reworked. Language clients are now
required to provide configuration parameters under the <tt class="docutils literal">initializationOptions</tt> field
in the <tt class="docutils literal">initialize</tt> request. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/192">#192</a>)</li>
</ul>
</div>
esbonio-sphinx-extensions-v0.0.2
<h1 class="title">v0.0.2 - 2021-06-05</h1>
<h2 class="subtitle" id="misc">Misc</h2>
<ul class="simple">
<li>No significant changes (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/206">#206</a>)</li>
</ul>
esbonio-language-server-v0.6.2
<h1 class="title">v0.6.2 - 2021-06-05</h1>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>The language server now correctly handles windows file URIs when determining Sphinx's
build directory. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/184">#184</a>)</li>
<li>Role and role target completions are now correctly generated when the role
is being typed within parenthesis e.g. <tt class="docutils literal"><span class="pre">(:kbd:...</span></tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/191">#191</a>)</li>
<li>Path variables like <tt class="docutils literal">${confDir}</tt> and <tt class="docutils literal">${workspaceRoot}</tt> are now properly expanded
even when there are no additional path elements. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/208">#208</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>The cli arguments <tt class="docutils literal"><span class="pre">--cache-dir</span></tt>, <tt class="docutils literal"><span class="pre">--log-filter</span></tt>, <tt class="docutils literal"><span class="pre">--log-level</span></tt> and
<tt class="docutils literal"><span class="pre">--hide-sphinx-output</span></tt> have been replaced with the configuration
parameters <tt class="docutils literal">esbonio.sphinx.buildDir</tt>, <tt class="docutils literal">esbonio.server.logFilter</tt>,
<tt class="docutils literal">esbonio.logLevel</tt> and <tt class="docutils literal">esbonio.server.hideSphinxOutput</tt> respectively (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/185">#185</a>)</li>
<li>The language server's startup sequence has been reworked. Language clients are now
required to provide configuration parameters under the <tt class="docutils literal">initializationOptions</tt> field
in the <tt class="docutils literal">initialize</tt> request. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/192">#192</a>)</li>
<li>The language server will now send an <cite>esbonio/buildComplete</cite> notification to
clients when it has finished (re)building the docs. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/193">#193</a>)</li>
<li>An entry for <tt class="docutils literal">esbonio</tt> has been added to the <tt class="docutils literal">console_scripts</tt>
entry point, so it's now possible to launch the language server by
calling <tt class="docutils literal">esbonio</tt> directly (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/195">#195</a>)</li>
</ul>
</div>
esbonio-vscode-extension-v0.6.2
<h1 class="title">v0.6.2 - 2021-05-14</h1>
<h2 class="subtitle" id="fixes">Fixes</h2>
<ul class="simple">
<li>Fix minimum required language server version (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/183">#183</a>)</li>
</ul>
esbonio-vscode-extension-v0.6.1
<h1 class="title">v0.6.1 - 2021-05-13</h1>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Literal blocks now have the correct syntax highlighting (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/138">#138</a>)</li>
<li>The language server is now reloaded when the Python environment is changed. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/140">#140</a>)</li>
<li>It's now possible to test dev builds of the language server with the extension (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/168">#168</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>Improvements to the development experience (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/170">#170</a>)</li>
</ul>
</div>
esbonio-language-server-v0.6.1
<h1 class="title">v0.6.1 - 2021-05-13</h1>
<h2 class="subtitle" id="fixes">Fixes</h2>
<ul class="simple">
<li>Intersphinx projects are now only included as completion suggestions for roles
which target object types in a project's inventory. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/158">#158</a>)</li>
<li>Fix the uri representation of Windows paths when reporting diagnostics (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/166">#166</a>)</li>
<li>The language server now attempts to recreate the Sphinx application if the user
updates a broken <tt class="docutils literal">conf.py</tt>. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/169">#169</a>)</li>
<li>The language server no longer crashes if clients don't send the <tt class="docutils literal">esbonio.sphinx</tt>
configuration object (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/171">#171</a>)</li>
<li>Docstrings from Sphinx and Docutils' base directive classes are no longer
included in completion suggestions as they are not useful. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/178">#178</a>)</li>
<li>Sphinx build time exceptions are now caught and reported (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/179">#179</a>)</li>
<li>Fix <tt class="docutils literal">Method not found: $/setTrace</tt> exceptions when running against VSCode (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/180">#180</a>)</li>
</ul>
esbonio-vscode-extension-v0.6.0
<h1 class="title">v0.6.0 - 2021-05-07</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>Add new <tt class="docutils literal">esbonio.sphinx.confDir</tt> option that allows for a project's config
directory to be explictly set should the automatic discovery in the Language
Server fail. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/63">#63</a>)</li>
<li>Add new <tt class="docutils literal">esbonio.sphinx.srcDir</tt> option that allows for overriding the
language server's assumption that source files are located in the same
place as the <tt class="docutils literal">conf.py</tt> file. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/142">#142</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Editor keybindings now only apply in <tt class="docutils literal">*.rst</tt> files. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/141">#141</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>Update <tt class="docutils literal"><span class="pre">vscode-languageclient</span></tt> to v7.0.0 (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/152">#152</a>)</li>
</ul>
</div>
esbonio-sphinx-extensions-v0.0.1
<h1 class="title">v0.0.1 - 2021-05-07</h1>
<h2 class="subtitle" id="misc">Misc</h2>
<ul class="simple">
<li>Initial release (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/146">#146</a>)</li>
</ul>
esbonio-language-server-v0.6.0
<h1 class="title">v0.6.0 - 2021-05-07</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>The Language Server will now offer filepath completions for the <tt class="docutils literal">image</tt>,
<tt class="docutils literal">figure</tt>, <tt class="docutils literal">include</tt> and <tt class="docutils literal">literalinclude</tt> directives as well as the
<tt class="docutils literal">download</tt> role. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/34">#34</a>)</li>
<li>Language clients can now override the default <tt class="docutils literal">conf.py</tt> discovery mechanism
by providing a <tt class="docutils literal">esbonio.sphinx.confDir</tt> config option. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/62">#62</a>)</li>
<li>Language clients can now override the assumption that Sphinx's <tt class="docutils literal">srcdir</tt>
is the same as its <tt class="docutils literal">confdir</tt> by providing a <tt class="docutils literal">esbonio.sphinx.srcDir</tt>
config option. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/142">#142</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>The Language Server no longer throws an exception while handling errors raised
during initialization of a Sphinx application. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/139">#139</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>Upgrage pygls to v0.10.x (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/144">#144</a>)</li>
</ul>
</div>
esbonio-lib-v0.5.1
<h1 class="title">v0.5.1 - 2021-04-20</h1>
<h2 class="subtitle" id="fixes">Fixes</h2>
<ul class="simple">
<li>Pin <tt class="docutils literal">pygls<0.10.0</tt> to ensure installs pick up a compatible version (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/147">#147</a>)</li>
</ul>
esbonio-vscode-v0.5.1
<h1 class="title">v0.5.1 - 2021-03-01</h1>
<h2 class="subtitle" id="misc">Misc</h2>
<ul class="simple">
<li>Fix release pipeline (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/135">#135</a>)</li>
</ul>
esbonio-lib-v0.5.0
<h1 class="title">v0.5.0 - 2021-02-25</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>The language server now reports invalid references as diagnostics (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/57">#57</a>)</li>
<li>Add <tt class="docutils literal"><span class="pre">--log-level</span></tt> cli argument that allows Language Clients to
control the verbosity of the Language Server's log output. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/87">#87</a>)</li>
<li>Directive completions are now domain aware. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/101">#101</a>)</li>
<li>Role and role target completions are now domain aware. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/104">#104</a>)</li>
<li>Intersphinx completions are now domain aware (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/106">#106</a>)</li>
<li>Add <tt class="docutils literal"><span class="pre">log-filter</span></tt> cli argument that allows Language Clients to choose
which loggers they want to recieve messages from. Also add
<tt class="docutils literal"><span class="pre">--hide-sphinx-output</span></tt> cli argument that can suppress Sphinx's build
log as it it handled separately. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/113">#113</a>)</li>
<li>Add <tt class="docutils literal"><span class="pre">-p</span></tt>, <tt class="docutils literal"><span class="pre">--port</span></tt> cli arguments that start the Language Server in
TCP mode while specifying the port number to listen on. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/114">#114</a>)</li>
<li>Add <tt class="docutils literal"><span class="pre">--cache-dir</span></tt> cli argument that allows Language Clients to
specify where cached data should be stored e.g. Sphinx's build output. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/115">#115</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>The language server now reloads when the project's <tt class="docutils literal">conf.py</tt> is modified (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/83">#83</a>)</li>
<li><tt class="docutils literal">$/setTraceNotification</tt> notifications from VSCode no longer cause exceptions to be thrown
in the Language Server. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/91">#91</a>)</li>
<li>Consistency errors are now included in reported diagnostics. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/94">#94</a>)</li>
<li>Ensure <tt class="docutils literal">:doc:</tt> completions are specified relative to the project root. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/102">#102</a>)</li>
</ul>
</div>
esbonio-vscode-v0.4.0
<h1 class="title">v0.4.0 - 2021-02-03</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>Expose an <tt class="docutils literal">esbonio.log.level</tt> config option that allows the level of logging
output to be configured (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/85">#85</a>)</li>
<li>Add <tt class="docutils literal">esbonio.server.updateFrequency</tt> option that controls how often the
extension should check for updates. Valid values are <tt class="docutils literal">daily</tt>, <tt class="docutils literal">weekly</tt>,
<tt class="docutils literal">monthly</tt> and <tt class="docutils literal">never`</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/88">#88</a>)</li>
<li>Add <tt class="docutils literal">esbonio.server.updateBehavior</tt> option that controls how updates should be
applied. Valid values are <tt class="docutils literal">promptAlways</tt>, <tt class="docutils literal">promptMajor</tt> and <tt class="docutils literal">automatic</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/89">#89</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Fix edge cases around syntax highlighting bold/italic elements. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/47">#47</a>)</li>
<li>The extension now activates when it detects a sphinx project (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/49">#49</a>)</li>
<li>The language client now also listens to changes in Python files so that we can
pick up changes in the project's <tt class="docutils literal">conf.py`</tt> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/50">#50</a>)</li>
<li>Fix edge cases around syntax highlighting inline code snippets (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/70">#70</a>)</li>
</ul>
</div>
esbonio-lib-v0.4.0
<h1 class="title">v0.4.0 - 2021-02-01</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li><dl class="first docutils">
<dt><strong>Language Server</strong> Directive option completions are now provided</dt>
<dd>within a directive's options block (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/36">#36</a>)</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Language Server</strong> For projects that use <tt class="docutils literal">interpshinx</tt> completions</dt>
<dd>for intersphinx targets are now suggested when available (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/74">#74</a>)</dd>
</dl>
</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li><dl class="first docutils">
<dt><strong>Language Server</strong> Regex that catches diagnostics from Sphinx's</dt>
<dd>output can now handle windows paths. Diagnostic reporting now sends a
proper URI (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/66">#66</a>)</dd>
</dl>
</li>
<li><strong>Language Server</strong> Diagnostics are now reported on first startup (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/68">#68</a>)</li>
<li><dl class="first docutils">
<dt><strong>Language Server</strong> Fix exception that was thrown when trying to find</dt>
<dd>completions for an unknown role type (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/73">#73</a>)</dd>
</dl>
</li>
<li><strong>Language Server</strong> The server will not offer completion suggestions outside of
a role target (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/77">#77</a>)</li>
</ul>
</div>
esbonio-lib-v0.3.0
<h1 class="title">v0.3.0 - 2021-01-27</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li><strong>Language Server</strong> Errors in Sphinx's build output are now parsed and published
to the LSP client as diagnostics (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/35">#35</a>)</li>
<li><strong>Language Server</strong> Directive completions now include a snippet that
prompts for any required arguments (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/58">#58</a>)
</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul>
<li><strong>Language Server</strong> Errors encountered when initialising Sphinx are now caught and the language
client is notified of an issue. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/33">#33</a>)
</li>
<li><strong>Language Server</strong> Fix issue where some malformed <tt>CompletionItem</tt>s were
preventing completion suggestions from being shown. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/54">#54</a>)
</li>
<li><strong>Language Server</strong> Windows paths are now handled correctly (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/60">#60</a>)
</li>
<li><strong>Language Server</strong> Server no longer chooses <tt class="docutils literal">conf.py</tt> files that</dt>
are located under a <tt class="docutils literal">.tox</tt> or <tt class="docutils literal"><span class="pre">site-packages</span></tt> directory (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/61">#61</a>)
</li>
</ul>
</div>
esbonio-vscode-v0.3.1
<h1 class="title">v0.3.1 - 2020-12-14</h1>
<h2 class="subtitle" id="misc">Misc</h2>
<ul class="simple">
<li>Fix <tt class="docutils literal">vsix</tt> packaging so that grammar tests are not included. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/44">#44</a>)</li>
</ul>
esbonio-vscode-v0.3.0
<h1 class="title">v0.3.0 - 2020-12-14</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul>
<li><p class="first">Add 2 commands that can be used to insert links. One that uses the inline syntax
<kbd>Alt+L</kbd>, the other, uses the named reference syntax <kbd>Alt+Shift+L</kbd> (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/37">#37</a>)</p>
</li>
<li><p class="first">Add command that will restart the language server (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/39">#39</a>)</p>
</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li>Support syntax highligting for more header styles. Support highligting python code
under directives from Sphinx's <tt class="docutils literal">sphinx.ext.doctest</tt> extension (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/42">#42</a>)</li>
</ul>
</div>
esbonio-lib-v0.2.1
<h1 class="title">v0.2.1 - 2020-12-08</h1>
<h2 class="subtitle" id="fixes">Fixes</h2>
<ul class="simple">
<li><strong>Language Server</strong> Directives that are part of the <tt class="docutils literal">std</tt> or <tt class="docutils literal">py</tt> Sphinx domains
will now be included in completion suggestions (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/31">#31</a>)</li>
</ul>
esbonio-lib-v0.2.0
<h1 class="title">v0.2.0 - 2020-12-06</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li><strong>Language Server:</strong> Python log events can now published to Language Clients (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/27">#27</a>)</li>
<li><strong>Language Server</strong> Sphinx's build output is now redirected to the LSP client as log
messages. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/28">#28</a>)</li>
<li><strong>Language Server</strong> Suggest completions for targets for a number of roles from the
<a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-standard-domain">std</a>
and <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain">py</a>
domains including <tt class="docutils literal">ref</tt>, <tt class="docutils literal">doc</tt>, <tt class="docutils literal">func</tt>, <tt class="docutils literal">meth</tt>, <tt class="docutils literal">class</tt> and more. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/29">#29</a>)</li>
</ul>
</div>
<div class="section" id="fixes">
<h1>Fixes</h1>
<ul class="simple">
<li><strong>Language Server:</strong> Fix discovery of roles so that roles in Sphinx domains are used and
that unimplemented <tt class="docutils literal">docutils</tt> roles are not surfaced. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/26">#26</a>)</li>
</ul>
</div>
esbonio-lib-v0.1.2
<h1 class="title">v0.1.2 - 2020-12-01</h1>
<h2 class="subtitle" id="misc">Misc</h2>
<ul class="simple">
<li>Use <tt class="docutils literal"><span class="pre">ubuntu-20.04</span></tt> for Python builds so that the correct version of <tt class="docutils literal">pandoc</tt> is
available (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/25">#25</a>)</li>
</ul>
esbonio-vscode0.2.1
<h1 class="title">v0.2.1 - 2020-11-28</h1>
<h2 class="subtitle" id="misc">Misc</h2>
<ul class="simple">
<li>The published <tt class="docutils literal">vsix</tt> now contains a changelog in a format that's compatible with the
VSCode marketplace. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/16">#16</a>)</li>
<li>The published <tt class="docutils literal">vsix</tt> package now only contains the files that are necessary. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/17">#17</a>)</li>
<li>The extension is now bundled into a single file using webpack (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/18">#18</a>)</li>
</ul>
esbonio-vscode0.2.0
<h1 class="title">v0.2.0 - 2020-11-27</h1>
<h2 class="subtitle" id="features">Features</h2>
<ul class="simple">
<li>If there is no Python interpreter configured and the
<a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=ms-python.python">Python extension</a>
is available, then esbonio will now use the interpreter that's been configured for the
Python extension (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/9">#9</a>)</li>
</ul>
esbonio-vscode0.1.0
<h1 class="title">v0.1.0 - 2020-11-23</h1>
<div class="section" id="features">
<h1>Features</h1>
<ul class="simple">
<li>If the language server is not installed, the extension will now prompt to install it.
It will also prompt to update it when new versions are available. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/12">#12</a>)</li>
</ul>
</div>
<div class="section" id="misc">
<h1>Misc</h1>
<ul class="simple">
<li>Update build pipeline to use <tt class="docutils literal">towncrier</tt> to autogenerate release notes and changelog
entries (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/10">#10</a>)</li>
</ul>
</div>
esbonio-lib-v0.0.6
<h1 class="title">0.0.6 - 2020-11-21</h1>
<h2 class="subtitle" id="misc">Misc</h2>
<ul class="simple">
<li>Add <tt class="docutils literal"><span class="pre">--version</span></tt> option to the cli that will print the version number and exit. (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/11">#11</a>)</li>
</ul>
esbonio-lib-v0.0.5
<h1 class="title">v0.0.5 - 2020-11-20</h1>
<h2 class="subtitle" id="misc">Misc</h2>
<ul class="simple">
<li>Update build pipeline to use <tt class="docutils literal">towncrier</tt> to autogenerate release notes
and changelog entries (<a class="reference external" href="https://github.com/swyddfa/esbonio/issues/5">#5</a>)</li>
</ul>
esbonio-lib-v0.0.3