Merge pull request #389 from swyddfa/develop

New Release

code/changes/360.deprecated.rst

@@ -0,0 +1,2 @@
+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``

code/changes/360.feature.rst

@@ -0,0 +1,2 @@
+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.

code/changes/374.misc.rst

@@ -0,0 +1 @@
+The ``esbonio.sphinx.numJobs`` configuration now defaults to ``1`` in line with ``sphinx-build`` defaults.

code/package.json

@@ -94,6 +94,16 @@
                 "title": "Restart Language Server",
                 "category": "Esbonio"
             },
+            {
+                "command": "esbonio.sphinx.copyBuildCommand",
+                "title": "Copy Sphinx Build Command",
+                "category": "Esbonio"
+            },
+            {
+                "command": "esbonio.sphinx.setBuildCommand",
+                "title": "Set Sphinx Build Command",
+                "category": "Esbonio"
+            },
             {
                 "command": "esbonio.sphinx.selectConfDir",
                 "title": "Select Conf Dir",
@@ -180,7 +190,8 @@
                         "scope": "window",
                         "type": "boolean",
                         "default": false,
-                        "description": "Hide Sphinx build output from the Language Server log."
+                        "description": "Hide Sphinx build output from the Language Server log.",
+                        "deprecationMessage": "This option will be removed when the language server reaches v1.0. The esbonio.sphinx.quiet and esbonio.sphinx.silent options should be used instead."
                     },
                     "esbonio.server.installBehavior": {
                         "scope": "window",
@@ -244,30 +255,91 @@
                         "description": "The directory in which to store Sphinx's build output.\n\nBy default the Language Server will store any build files in a storage area provided by VSCode, this option allows you to override this to be a directory of your choosing e.g. your local _build/ directory.",
                         "markdownDescription": "The directory in which to store Sphinx's build output.\n\nBy default the Language Server will store any build files in a storage area provided by VSCode, this option allows you to override this to be a directory of your choosing e.g. your local `_build/` directory."
                     },
+                    "esbonio.sphinx.builderName": {
+                        "scope": "window",
+                        "type": "string",
+                        "default": "html",
+                        "description": "The builder to use when building the documentation.",
+                        "markdownDescription": "The builder to use when building the documentation. **Note:** While many builders will work fine, many features (such as previews) will only work with the `html` builder."
+                    },
                     "esbonio.sphinx.confDir": {
                         "scope": "window",
                         "type": "string",
                         "default": null,
                         "description": "The Language Server should be able to automatically find the folder containing your project's 'conf.py' file. However this setting can be used to force the Language Server to use a particular directory if required."
                     },
+                    "esbonio.sphinx.configOverrides": {
+                        "scope": "window",
+                        "type": "object",
+                        "default": {},
+                        "description": "Any conf.py options to override."
+                    },
+                    "esbonio.sphinx.doctreeDir": {
+                        "scope": "window",
+                        "type": "string",
+                        "default": null,
+                        "description": "The directory in which to store Sphinx's doctree cache."
+                    },
                     "esbonio.sphinx.forceFullBuild": {
+                        "scope": "window",
+                        "type": "boolean",
+                        "default": false,
+                        "description": "Force a full build of the documentation project on server startup."
+                    },
+                    "esbonio.sphinx.keepGoing": {
+                        "scope": "window",
+                        "type": "boolean",
+                        "default": false,
+                        "description": "Continue building when errors generated from warnings are encountered"
+                    },
+                    "esbonio.sphinx.makeMode": {
                         "scope": "window",
                         "type": "boolean",
                         "default": true,
-                        "description": "By default the language server will force a full build of your documentation on startup to help improve the accuracy of some features like diagnostics. Disabling this option can help improve startup time for larger projects at the expense of certain features being less accurate."
+                        "description": "Flag indicating if the language server should be have like a sphinx-build -M ... command"
                     },
                     "esbonio.sphinx.numJobs": {
                         "scope": "window",
                         "type": "integer",
-                        "default": 0,
+                        "default": 1,
                         "markdownDescription": "The number of parallel jobs to use during a Sphinx build.\n\n- A value of `0` is equivalent to passing `-j auto` to a `sphinx-build` command.\n- A value of `1` will disable parallel processing."
                     },
+                    "esbonio.sphinx.quiet": {
+                        "scope": "window",
+                        "type": "boolean",
+                        "default": false,
+                        "description": "Hide standard Sphinx output messages"
+                    },
+                    "esbonio.sphinx.silent": {
+                        "scope": "window",
+                        "type": "boolean",
+                        "default": false,
+                        "description": "Hide all Sphinx output"
+                    },
                     "esbonio.sphinx.srcDir": {
                         "scope": "window",
                         "type": "string",
                         "default": null,
-                        "description": "The directory containing your rst source files. By default the Language Server will assume this is the same as `esbonio.sphinx.confDir` but this opton can override this if necessary.",
-                        "markdownDescription": "The directory containing your rst source files. By default the Language Server will assume this is the same as `#esbonio.sphinx.confDir#` but this opton can override this if necessary."
+                        "description": "The directory containing your rst source files. By default the Language Server will assume this is the same as `esbonio.sphinx.confDir` but this option can override this if necessary.",
+                        "markdownDescription": "The directory containing your rst source files. By default the Language Server will assume this is the same as `#esbonio.sphinx.confDir#` but this option can override this if necessary."
+                    },
+                    "esbonio.sphinx.tags": {
+                        "scope": "window",
+                        "type": "array",
+                        "default": [],
+                        "description": "Tags to enable during a build."
+                    },
+                    "esbonio.sphinx.verbosity": {
+                        "scope": "window",
+                        "type": "integer",
+                        "default": 0,
+                        "description": "The verbosity of Sphinx's output"
+                    },
+                    "esbonio.sphinx.warningIsError": {
+                        "scope": "window",
+                        "type": "boolean",
+                        "default": false,
+                        "description": "Treat any warnings as errors."
                     }
                 }
             }

code/src/constants.ts

@@ -11,6 +11,8 @@ export namespace Commands {
   export const OPEN_PREVIEW = "esbonio.preview.open"
   export const OPEN_PREVIEW_TO_SIDE = "esbonio.preview.openSide"
 
+  export const COPY_BUILD_COMMAND = "esbonio.sphinx.copyBuildCommand"
+  export const SET_BUILD_COMMAND = "esbonio.sphinx.setBuildCommand"
   export const SELECT_CONFDIR = "esbonio.sphinx.selectConfDir"
   export const SELECT_SRCDIR = "esbonio.sphinx.selectSrcDir"
   export const SELECT_BUILDDIR = "esbonio.sphinx.selectBuildDir"