Update documentation

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 8d878a9d180d2491b0aaa806e18d17db
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/api_handler.rst.txt

@@ -0,0 +1,30 @@
+API Handler
+===========
+
+ApiWrapperInterface
+-------------------
+
+.. autoclass:: lsp_utils.ApiWrapperInterface
+
+API Decorators
+--------------
+
+Decorators can be used as an alternative to attaching listeners to the :class:`lsp_utils.ApiWrapperInterface` instance obtained through :meth:`lsp_utils.GenericClientHandler.on_ready()`.
+
+To use, attach the decorator to a function and call it with the name of the notification or the request that you want to handle. It can also be called with a list of names, if you want to use the same handler to handle multiple requests.
+
+Example usage:
+
+.. code:: py
+
+    @notification_handler('eslint/status')
+    def handle_status(self, params: Any) -> None:
+        print(status)
+
+    @request_handler('eslint/openDoc')
+    def handle_open_doc(self, params: Any, respond: Callable[[Any], None]) -> None:
+        webbrowser.open(params['url'])
+        respond({})
+
+.. autoclass:: lsp_utils.request_handler
+.. autoclass:: lsp_utils.notification_handler

_sources/client_handlers.rst.txt

@@ -0,0 +1,17 @@
+Client Handlers
+===============
+
+GenericClientHandler
+--------------------
+
+.. autoclass:: lsp_utils.GenericClientHandler
+
+NpmClientHandler
+----------------
+
+.. autoclass:: lsp_utils.NpmClientHandler
+
+PipClientHandler
+----------------
+
+.. autoclass:: lsp_utils.pip_client_handler.PipClientHandler

_sources/index.rst.txt

@@ -0,0 +1,35 @@
+lsp_utils
+=========
+
+Module with LSP-related utilities for Sublime Text
+
+How to use
+----------
+
+1. Create a `dependencies.json` file in your package root with the following contents:
+
+.. code:: py
+
+   {
+      "*": {
+         "*": [
+            "lsp_utils",
+            "sublime_lib"
+         ]
+      }
+   }
+
+2. Run the **Package Control: Satisfy Dependencies** command via command palette
+
+
+See also documentation on dependencies_.
+
+.. _dependencies: https://packagecontrol.io/docs/dependencies
+
+.. toctree::
+   :caption: API Documentation
+
+   client_handlers
+   server_resource_handlers
+   api_handler
+   utilities

_sources/server_resource_handlers.rst.txt

@@ -0,0 +1,17 @@
+Server Resource Handlers
+========================
+
+ServerStatus
+------------
+
+.. autoclass:: lsp_utils.ServerStatus
+
+ServerResourceInterface
+-----------------------
+
+.. autoclass:: lsp_utils.ServerResourceInterface
+
+ServerPipResource
+-----------------
+
+.. autoclass:: lsp_utils.ServerPipResource

_sources/utilities.rst.txt

@@ -0,0 +1,4 @@
+Utilities
+---------
+
+.. automodule:: lsp_utils.helpers

_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}