Skip to content

Commit 5f98838

Browse files
cloudant-sdks-automationcloudant-sdks-automation
committed
Pydoc for release 0.11.1 (66ff5d7)
1 parent b96273b commit 5f98838

File tree

75 files changed

+28128
-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.

75 files changed

+28128
-1
lines changed

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

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

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

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
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:: validate()
61+
:canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.validate
62+
63+
.. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.validate
64+
:parser: myst

‎docs/0.11.1/_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.11.1/_sources/apidocs/ibmcloudant/ibmcloudant.features.pagination.rst.txt‎

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
:py:mod:`ibmcloudant.features.pagination`
2+
=========================================
3+
4+
.. py:module:: ibmcloudant.features.pagination
5+
6+
.. autodoc2-docstring:: ibmcloudant.features.pagination
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:`Pager <ibmcloudant.features.pagination.Pager>`
21+
- .. autodoc2-docstring:: ibmcloudant.features.pagination.Pager
22+
:parser: myst
23+
:summary:
24+
* - :py:obj:`PagerType <ibmcloudant.features.pagination.PagerType>`
25+
- .. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType
26+
:parser: myst
27+
:summary:
28+
* - :py:obj:`Pagination <ibmcloudant.features.pagination.Pagination>`
29+
- .. autodoc2-docstring:: ibmcloudant.features.pagination.Pagination
30+
:parser: myst
31+
:summary:
32+
33+
Data
34+
~~~~
35+
36+
.. list-table::
37+
:class: autosummary longtable
38+
:align: left
39+
40+
* - :py:obj:`I <ibmcloudant.features.pagination.I>`
41+
- .. autodoc2-docstring:: ibmcloudant.features.pagination.I
42+
:parser: myst
43+
:summary:
44+
* - :py:obj:`K <ibmcloudant.features.pagination.K>`
45+
- .. autodoc2-docstring:: ibmcloudant.features.pagination.K
46+
:parser: myst
47+
:summary:
48+
* - :py:obj:`R <ibmcloudant.features.pagination.R>`
49+
- .. autodoc2-docstring:: ibmcloudant.features.pagination.R
50+
:parser: myst
51+
:summary:
52+
53+
API
54+
~~~
55+
56+
.. py:data:: I
57+
:canonical: ibmcloudant.features.pagination.I
58+
:value: 'TypeVar(...)'
59+
60+
.. autodoc2-docstring:: ibmcloudant.features.pagination.I
61+
:parser: myst
62+
63+
.. py:data:: K
64+
:canonical: ibmcloudant.features.pagination.K
65+
:value: 'TypeVar(...)'
66+
67+
.. autodoc2-docstring:: ibmcloudant.features.pagination.K
68+
:parser: myst
69+
70+
.. py:class:: Pager
71+
:canonical: ibmcloudant.features.pagination.Pager
72+
73+
Bases: :py:obj:`typing.Protocol`\ [\ :py:obj:`ibmcloudant.features.pagination.I`\ ]
74+
75+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pager
76+
:parser: myst
77+
78+
.. py:method:: get_all() -> collections.abc.Sequence[ibmcloudant.features.pagination.I]
79+
:canonical: ibmcloudant.features.pagination.Pager.get_all
80+
:abstractmethod:
81+
82+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pager.get_all
83+
:parser: myst
84+
85+
.. py:method:: get_next() -> collections.abc.Sequence[ibmcloudant.features.pagination.I]
86+
:canonical: ibmcloudant.features.pagination.Pager.get_next
87+
:abstractmethod:
88+
89+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pager.get_next
90+
:parser: myst
91+
92+
.. py:method:: has_next() -> bool
93+
:canonical: ibmcloudant.features.pagination.Pager.has_next
94+
:abstractmethod:
95+
96+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pager.has_next
97+
:parser: myst
98+
99+
.. py:class:: PagerType
100+
:canonical: ibmcloudant.features.pagination.PagerType
101+
102+
Bases: :py:obj:`enum.Enum`
103+
104+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType
105+
:parser: myst
106+
107+
.. py:attribute:: POST_ALL_DOCS
108+
:canonical: ibmcloudant.features.pagination.PagerType.POST_ALL_DOCS
109+
:value: 'auto(...)'
110+
111+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType.POST_ALL_DOCS
112+
:parser: myst
113+
114+
.. py:attribute:: POST_DESIGN_DOCS
115+
:canonical: ibmcloudant.features.pagination.PagerType.POST_DESIGN_DOCS
116+
:value: 'auto(...)'
117+
118+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType.POST_DESIGN_DOCS
119+
:parser: myst
120+
121+
.. py:attribute:: POST_FIND
122+
:canonical: ibmcloudant.features.pagination.PagerType.POST_FIND
123+
:value: 'auto(...)'
124+
125+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType.POST_FIND
126+
:parser: myst
127+
128+
.. py:attribute:: POST_PARTITION_ALL_DOCS
129+
:canonical: ibmcloudant.features.pagination.PagerType.POST_PARTITION_ALL_DOCS
130+
:value: 'auto(...)'
131+
132+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType.POST_PARTITION_ALL_DOCS
133+
:parser: myst
134+
135+
.. py:attribute:: POST_PARTITION_FIND
136+
:canonical: ibmcloudant.features.pagination.PagerType.POST_PARTITION_FIND
137+
:value: 'auto(...)'
138+
139+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType.POST_PARTITION_FIND
140+
:parser: myst
141+
142+
.. py:attribute:: POST_PARTITION_SEARCH
143+
:canonical: ibmcloudant.features.pagination.PagerType.POST_PARTITION_SEARCH
144+
:value: 'auto(...)'
145+
146+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType.POST_PARTITION_SEARCH
147+
:parser: myst
148+
149+
.. py:attribute:: POST_PARTITION_VIEW
150+
:canonical: ibmcloudant.features.pagination.PagerType.POST_PARTITION_VIEW
151+
:value: 'auto(...)'
152+
153+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType.POST_PARTITION_VIEW
154+
:parser: myst
155+
156+
.. py:attribute:: POST_SEARCH
157+
:canonical: ibmcloudant.features.pagination.PagerType.POST_SEARCH
158+
:value: 'auto(...)'
159+
160+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType.POST_SEARCH
161+
:parser: myst
162+
163+
.. py:attribute:: POST_VIEW
164+
:canonical: ibmcloudant.features.pagination.PagerType.POST_VIEW
165+
:value: 'auto(...)'
166+
167+
.. autodoc2-docstring:: ibmcloudant.features.pagination.PagerType.POST_VIEW
168+
:parser: myst
169+
170+
.. py:class:: Pagination(client: ibmcloudant.cloudant_v1.CloudantV1, type: ibmcloudant.features.pagination.PagerType, opts: dict)
171+
:canonical: ibmcloudant.features.pagination.Pagination
172+
173+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pagination
174+
:parser: myst
175+
176+
.. rubric:: Initialization
177+
178+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pagination.__init__
179+
:parser: myst
180+
181+
.. py:method:: new_pagination(client: ibmcloudant.cloudant_v1.CloudantV1, type: ibmcloudant.features.pagination.PagerType, **kwargs)
182+
:canonical: ibmcloudant.features.pagination.Pagination.new_pagination
183+
:classmethod:
184+
185+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pagination.new_pagination
186+
:parser: myst
187+
188+
.. py:method:: pager() -> ibmcloudant.features.pagination.Pager[ibmcloudant.features.pagination.I]
189+
:canonical: ibmcloudant.features.pagination.Pagination.pager
190+
191+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pagination.pager
192+
:parser: myst
193+
194+
.. py:method:: pages() -> collections.abc.Iterable[collections.abc.Sequence[ibmcloudant.features.pagination.I]]
195+
:canonical: ibmcloudant.features.pagination.Pagination.pages
196+
197+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pagination.pages
198+
:parser: myst
199+
200+
.. py:method:: rows() -> collections.abc.Iterable[ibmcloudant.features.pagination.I]
201+
:canonical: ibmcloudant.features.pagination.Pagination.rows
202+
203+
.. autodoc2-docstring:: ibmcloudant.features.pagination.Pagination.rows
204+
:parser: myst
205+
206+
.. py:data:: R
207+
:canonical: ibmcloudant.features.pagination.R
208+
:value: 'TypeVar(...)'
209+
210+
.. autodoc2-docstring:: ibmcloudant.features.pagination.R
211+
:parser: myst

‎docs/0.11.1/_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`

0 commit comments

Comments
 (0)