code: Stop injecting active Python env into config

Author: alcarney

code/changes/881.misc.md

@@ -0,0 +1,7 @@
+**IMPORTANT!**
+
+The VSCode extension will no longer automatically inject the currently active Python interpreter into the configuration sent to the server.
+It is now required for all users to set the `esbonio.sphinx.pythonCommand` option, either in your VSCode settings, or in your project's `pyproject.toml` file.
+
+This makes VSCode's behavior more predicable and brings it in line with how other editors behave.
+It also encourages the sharing of project configuration settings, which is particuarly useful if you use an [environment manager](https://docs.esbon.io/en/latest/lsp/howto/use-esbonio-with.html)

code/guides/bring-your-own-sphinx.md

@@ -4,7 +4,4 @@ While the `esbonio` language server is bundled as part of the extension, it does
 
 This is because every Sphinx project is unique with its own set of dependencies and required extensions. In order to correctly understand your project `esbonio` needs to use the same Python environment that you use to build your documentation.
 
-The Esbonio extension supports two mechanisms for selecting your Python environment.
-
-1. If the official Python extension is available, by default Esbonio will attempt to use the same environment you have configured for your workspace.
-2. Alternatively, you can use the `esbonio.sphinx.pythonCommand` setting to override this behavior.
+You can tell Esbonio which environment to use by setting the `esbonio.sphinx.pythonCommand` option. See [this guide](https://docs.esbon.io/en/latest/lsp/howto/use-esbonio-with.html) for some examples

code/src/node/client.ts

@@ -338,9 +338,6 @@ export class EsbonioClient {
    * transport.
    */
   private getLanguageClientOptions(config: vscode.WorkspaceConfiguration): LanguageClientOptions {
-
-
-
     let documentSelector = config.get<TextDocumentFilter[]>("server.documentSelector")
     if (!documentSelector || documentSelector.length === 0) {
       documentSelector = Server.DEFAULT_SELECTOR
@@ -361,8 +358,7 @@ export class EsbonioClient {
               return result
             }
 
-            result.forEach(async (config, i) => {
-              await this.injectPython(params, i, config)
+            result.forEach((config) => {
               this.stripNulls(config)
             })
             return result
@@ -394,31 +390,6 @@ export class EsbonioClient {
     }
   }
 
-  /**
-   * Inject the user's configured Python interpreter into the configuration.
-   */
-  private async injectPython(params: ConfigurationParams, index: number, config: any) {
-    if (params.items[index].section !== "esbonio") {
-      return
-    }
-
-    if (config?.sphinx?.pythonCommand?.length > 0) {
-      return
-    }
-
-    // User has not explictly configured a Python command, try and inject the
-    // Python interpreter they have configured for this resource.
-    let scopeUri: vscode.Uri | undefined
-    let scope = params.items[index].scopeUri
-    if (scope) {
-      scopeUri = vscode.Uri.parse(scope)
-    }
-    let python = await this.python.getCmd(scopeUri)
-    if (python) {
-      config.sphinx.pythonCommand = python
-    }
-  }
-
   private callHandlers(method: string, params: any) {
     this.handlers.get(method)?.forEach(handler => {
       try {