Skip to content

Commit 9c8860a

Browse files
cloudant-sdks-automationcloudant-sdks-automation
committed
Pydoc for release 0.10.4 (b3b7f0d)
1 parent 9a23e8b commit 9c8860a

File tree

73 files changed

+27337
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+27337
-1
lines changed

‎docs/0.10.4/_sources/apidocs/ibmcloudant/ibmcloudant.cloudant_v1.rst.txt‎

Lines changed: 5994 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/0.10.4/_sources/apidocs/ibmcloudant/ibmcloudant.couchdb_session_authenticator.rst.txt‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
:py:mod:`ibmcloudant.couchdb_session_authenticator`
2+
===================================================
3+
4+
.. py:module:: ibmcloudant.couchdb_session_authenticator
5+
6+
.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator
7+
:parser: myst
8+
:allowtitles:
9+
10+
Module Contents
11+
---------------
12+
13+
Classes
14+
~~~~~~~
15+
16+
.. list-table::
17+
:class: autosummary longtable
18+
:align: left
19+
20+
* - :py:obj:`CouchDbSessionAuthenticator <ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator>`
21+
- .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator
22+
:parser: myst
23+
:summary:
24+
25+
API
26+
~~~
27+
28+
.. py:class:: CouchDbSessionAuthenticator(username: str, password: str, disable_ssl_verification: bool = False)
29+
:canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator
30+
31+
Bases: :py:obj:`ibm_cloud_sdk_core.authenticators.Authenticator`
32+
33+
.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator
34+
:parser: myst
35+
36+
.. rubric:: Initialization
37+
38+
.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.__init__
39+
:parser: myst
40+
41+
.. py:attribute:: AUTHTYPE_COUCHDB_SESSION
42+
:canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.AUTHTYPE_COUCHDB_SESSION
43+
:value: 'COUCHDB_SESSION'
44+
45+
.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.AUTHTYPE_COUCHDB_SESSION
46+
:parser: myst
47+
48+
.. py:method:: authenticate(req: requests.Request)
49+
:canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authenticate
50+
51+
.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authenticate
52+
:parser: myst
53+
54+
.. py:method:: authentication_type() -> str
55+
:canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authentication_type
56+
57+
.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authentication_type
58+
:parser: myst
59+
60+
.. py:method:: set_jar(jar)
61+
:canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.set_jar
62+
63+
.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.set_jar
64+
:parser: myst
65+
66+
.. py:method:: validate()
67+
:canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.validate
68+
69+
.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.validate
70+
:parser: myst

‎docs/0.10.4/_sources/apidocs/ibmcloudant/ibmcloudant.features.changes_follower.rst.txt‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
:py:mod:`ibmcloudant.features.changes_follower`
2+
===============================================
3+
4+
.. py:module:: ibmcloudant.features.changes_follower
5+
6+
.. autodoc2-docstring:: ibmcloudant.features.changes_follower
7+
:parser: myst
8+
:allowtitles:
9+
10+
Module Contents
11+
---------------
12+
13+
Classes
14+
~~~~~~~
15+
16+
.. list-table::
17+
:class: autosummary longtable
18+
:align: left
19+
20+
* - :py:obj:`ChangesFollower <ibmcloudant.features.changes_follower.ChangesFollower>`
21+
- .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower
22+
:parser: myst
23+
:summary:
24+
25+
API
26+
~~~
27+
28+
.. py:class:: ChangesFollower(service: ibmcloudant.cloudant_v1.CloudantV1, *, error_tolerance: int = _FOREVER, **kwargs)
29+
:canonical: ibmcloudant.features.changes_follower.ChangesFollower
30+
31+
.. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower
32+
:parser: myst
33+
34+
.. rubric:: Initialization
35+
36+
.. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.__init__
37+
:parser: myst
38+
39+
.. py:property:: error_tolerance
40+
:canonical: ibmcloudant.features.changes_follower.ChangesFollower.error_tolerance
41+
:type: int
42+
43+
.. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.error_tolerance
44+
:parser: myst
45+
46+
.. py:property:: options
47+
:canonical: ibmcloudant.features.changes_follower.ChangesFollower.options
48+
:type: typing.Dict
49+
50+
.. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.options
51+
:parser: myst
52+
53+
.. py:method:: start() -> typing.Iterator[ibmcloudant.cloudant_v1.ChangesResultItem]
54+
:canonical: ibmcloudant.features.changes_follower.ChangesFollower.start
55+
56+
.. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.start
57+
:parser: myst
58+
59+
.. py:method:: start_one_off() -> typing.Iterator[ibmcloudant.cloudant_v1.ChangesResultItem]
60+
:canonical: ibmcloudant.features.changes_follower.ChangesFollower.start_one_off
61+
62+
.. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.start_one_off
63+
:parser: myst
64+
65+
.. py:method:: stop() -> None
66+
:canonical: ibmcloudant.features.changes_follower.ChangesFollower.stop
67+
68+
.. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.stop
69+
:parser: myst

‎docs/0.10.4/_sources/index.rst.txt‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. Cloudant Python SDK documentation master file, created by
2+
sphinx-quickstart on Tue Jan 5 13:47:50 2021.
3+
Copyright IBM Corporation 2021, 2023.
4+
SPDX-License-Identifier: Apache-2.0
5+
You can adapt this file completely to your liking, but it should at least
6+
contain the root `toctree` directive.
7+
8+
Cloudant Python SDK's Documentation
9+
===================================
10+
11+
CloudantV1 class
12+
----------------
13+
14+
:class:`CloudantV1 <ibmcloudant.cloudant_v1.CloudantV1>`
15+
16+
Modules
17+
-------
18+
19+
.. toctree::
20+
:maxdepth: 4
21+
22+
cloudant_v1 <apidocs/ibmcloudant/ibmcloudant.cloudant_v1>
23+
couchdb_session_authenticator <apidocs/ibmcloudant/ibmcloudant.couchdb_session_authenticator>
24+
changes_follower <apidocs/ibmcloudant/ibmcloudant.features.changes_follower>
25+
26+
Indices and tables
27+
------------------
28+
29+
* :ref:`genindex`
30+
* :ref:`modindex`

‎docs/0.10.4/_static/_sphinx_javascript_frameworks_compat.js‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
/* Compatability shim for jQuery and underscores.js.
2+
*
3+
* Copyright Sphinx contributors
4+
* Released under the two clause BSD licence
5+
*/
6+
7+
/**
8+
* small helper function to urldecode strings
9+
*
10+
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
11+
*/
12+
jQuery.urldecode = function(x) {
13+
if (!x) {
14+
return x
15+
}
16+
return decodeURIComponent(x.replace(/\+/g, ' '));
17+
};
18+
19+
/**
20+
* small helper function to urlencode strings
21+
*/
22+
jQuery.urlencode = encodeURIComponent;
23+
24+
/**
25+
* This function returns the parsed url parameters of the
26+
* current request. Multiple values per key are supported,
27+
* it will always return arrays of strings for the value parts.
28+
*/
29+
jQuery.getQueryParameters = function(s) {
30+
if (typeof s === 'undefined')
31+
s = document.location.search;
32+
var parts = s.substr(s.indexOf('?') + 1).split('&');
33+
var result = {};
34+
for (var i = 0; i < parts.length; i++) {
35+
var tmp = parts[i].split('=', 2);
36+
var key = jQuery.urldecode(tmp[0]);
37+
var value = jQuery.urldecode(tmp[1]);
38+
if (key in result)
39+
result[key].push(value);
40+
else
41+
result[key] = [value];
42+
}
43+
return result;
44+
};
45+
46+
/**
47+
* highlight a given string on a jquery object by wrapping it in
48+
* span elements with the given class name.
49+
*/
50+
jQuery.fn.highlightText = function(text, className) {
51+
function highlight(node, addItems) {
52+
if (node.nodeType === 3) {
53+
var val = node.nodeValue;
54+
var pos = val.toLowerCase().indexOf(text);
55+
if (pos >= 0 &&
56+
!jQuery(node.parentNode).hasClass(className) &&
57+
!jQuery(node.parentNode).hasClass("nohighlight")) {
58+
var span;
59+
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
60+
if (isInSVG) {
61+
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
62+
} else {
63+
span = document.createElement("span");
64+
span.className = className;
65+
}
66+
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
67+
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
68+
document.createTextNode(val.substr(pos + text.length)),
69+
node.nextSibling));
70+
node.nodeValue = val.substr(0, pos);
71+
if (isInSVG) {
72+
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
73+
var bbox = node.parentElement.getBBox();
74+
rect.x.baseVal.value = bbox.x;
75+
rect.y.baseVal.value = bbox.y;
76+
rect.width.baseVal.value = bbox.width;
77+
rect.height.baseVal.value = bbox.height;
78+
rect.setAttribute('class', className);
79+
addItems.push({
80+
"parent": node.parentNode,
81+
"target": rect});
82+
}
83+
}
84+
}
85+
else if (!jQuery(node).is("button, select, textarea")) {
86+
jQuery.each(node.childNodes, function() {
87+
highlight(this, addItems);
88+
});
89+
}
90+
}
91+
var addItems = [];
92+
var result = this.each(function() {
93+
highlight(this, addItems);
94+
});
95+
for (var i = 0; i < addItems.length; ++i) {
96+
jQuery(addItems[i].parent).before(addItems[i].target);
97+
}
98+
return result;
99+
};
100+
101+
/*
102+
* backward compatibility for jQuery.browser
103+
* This will be supported until firefox bug is fixed.
104+
*/
105+
if (!jQuery.browser) {
106+
jQuery.uaMatch = function(ua) {
107+
ua = ua.toLowerCase();
108+
109+
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
110+
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
111+
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
112+
/(msie) ([\w.]+)/.exec(ua) ||
113+
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
114+
[];
115+
116+
return {
117+
browser: match[ 1 ] || "",
118+
version: match[ 2 ] || "0"
119+
};
120+
};
121+
jQuery.browser = {};
122+
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
123+
}

0 commit comments

Comments
 (0)