Pydoc for release 0.9.3 (92f4759)

docs/0.9.3/_sources/apidocs/ibmcloudant/ibmcloudant.couchdb_session_authenticator.rst.txt

@@ -0,0 +1,70 @@
+:py:mod:`ibmcloudant.couchdb_session_authenticator`
+===================================================
+
+.. py:module:: ibmcloudant.couchdb_session_authenticator
+
+.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator
+   :parser: myst
+   :allowtitles:
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. list-table::
+   :class: autosummary longtable
+   :align: left
+
+   * - :py:obj:`CouchDbSessionAuthenticator <ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator>`
+     - .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator
+          :parser: myst
+          :summary:
+
+API
+~~~
+
+.. py:class:: CouchDbSessionAuthenticator(username: str, password: str, disable_ssl_verification: bool = False)
+   :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator
+
+   Bases: :py:obj:`ibm_cloud_sdk_core.authenticators.Authenticator`
+
+   .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator
+      :parser: myst
+
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.__init__
+      :parser: myst
+
+   .. py:attribute:: AUTHTYPE_COUCHDB_SESSION
+      :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.AUTHTYPE_COUCHDB_SESSION
+      :value: 'COUCHDB_SESSION'
+
+      .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.AUTHTYPE_COUCHDB_SESSION
+         :parser: myst
+
+   .. py:method:: authenticate(req: requests.Request)
+      :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authenticate
+
+      .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authenticate
+         :parser: myst
+
+   .. py:method:: authentication_type() -> str
+      :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authentication_type
+
+      .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authentication_type
+         :parser: myst
+
+   .. py:method:: set_jar(jar)
+      :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.set_jar
+
+      .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.set_jar
+         :parser: myst
+
+   .. py:method:: validate()
+      :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.validate
+
+      .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.validate
+         :parser: myst

docs/0.9.3/_sources/apidocs/ibmcloudant/ibmcloudant.features.changes_follower.rst.txt

@@ -0,0 +1,69 @@
+:py:mod:`ibmcloudant.features.changes_follower`
+===============================================
+
+.. py:module:: ibmcloudant.features.changes_follower
+
+.. autodoc2-docstring:: ibmcloudant.features.changes_follower
+   :parser: myst
+   :allowtitles:
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. list-table::
+   :class: autosummary longtable
+   :align: left
+
+   * - :py:obj:`ChangesFollower <ibmcloudant.features.changes_follower.ChangesFollower>`
+     - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower
+          :parser: myst
+          :summary:
+
+API
+~~~
+
+.. py:class:: ChangesFollower(service: ibmcloudant.cloudant_v1.CloudantV1, *, error_tolerance: int = _FOREVER, **kwargs)
+   :canonical: ibmcloudant.features.changes_follower.ChangesFollower
+
+   .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower
+      :parser: myst
+
+   .. rubric:: Initialization
+
+   .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.__init__
+      :parser: myst
+
+   .. py:property:: error_tolerance
+      :canonical: ibmcloudant.features.changes_follower.ChangesFollower.error_tolerance
+      :type: int
+
+      .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.error_tolerance
+         :parser: myst
+
+   .. py:property:: options
+      :canonical: ibmcloudant.features.changes_follower.ChangesFollower.options
+      :type: typing.Dict
+
+      .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.options
+         :parser: myst
+
+   .. py:method:: start() -> typing.Iterator[ibmcloudant.cloudant_v1.ChangesResultItem]
+      :canonical: ibmcloudant.features.changes_follower.ChangesFollower.start
+
+      .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.start
+         :parser: myst
+
+   .. py:method:: start_one_off() -> typing.Iterator[ibmcloudant.cloudant_v1.ChangesResultItem]
+      :canonical: ibmcloudant.features.changes_follower.ChangesFollower.start_one_off
+
+      .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.start_one_off
+         :parser: myst
+
+   .. py:method:: stop() -> None
+      :canonical: ibmcloudant.features.changes_follower.ChangesFollower.stop
+
+      .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.stop
+         :parser: myst

docs/0.9.3/_sources/index.rst.txt

@@ -0,0 +1,30 @@
+.. Cloudant Python SDK documentation master file, created by
+   sphinx-quickstart on Tue Jan  5 13:47:50 2021.
+   Copyright IBM Corporation 2021, 2023.
+   SPDX-License-Identifier: Apache-2.0
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Cloudant Python SDK's Documentation
+===================================
+
+CloudantV1 class
+----------------
+
+:class:`CloudantV1 <ibmcloudant.cloudant_v1.CloudantV1>`
+
+Modules
+-------
+
+.. toctree::
+   :maxdepth: 4
+
+   cloudant_v1 <apidocs/ibmcloudant/ibmcloudant.cloudant_v1>
+   couchdb_session_authenticator <apidocs/ibmcloudant/ibmcloudant.couchdb_session_authenticator>
+   changes_follower <apidocs/ibmcloudant/ibmcloudant.features.changes_follower>
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`

docs/0.9.3/_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;
+}