Skip to content

Commit 804d32d

Browse files
committed
restructure docs
1 parent c56fbce commit 804d32d

File tree

1 file changed

+51
-17
lines changed

1 file changed

+51
-17
lines changed

docs/apireference.rst

Lines changed: 51 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,74 +10,117 @@ YDB API Reference
1010
Driver
1111
------
1212

13-
.. autoclass:: ydb.Driver
13+
DriverConfig
14+
^^^^^^^^^^^^
15+
16+
.. autoclass:: ydb.DriverConfig
1417
:members:
1518
:inherited-members:
1619
:undoc-members:
20+
:exclude-members: database, ca_cert, channel_options, secure_channel, endpoint, endpoints, credentials, use_all_nodes, root_certificates, certificate_chain, private_key, grpc_keep_alive_timeout, table_client_settings, primary_user_agent
1721

1822

19-
.. autoclass:: ydb.DriverConfig
23+
Driver
24+
^^^^^^
25+
26+
.. autoclass:: ydb.Driver
2027
:members:
2128
:inherited-members:
2229
:undoc-members:
23-
:exclude-members: database, ca_cert, channel_options, secure_channel, endpoint, endpoints, credentials, use_all_nodes, root_certificates, certificate_chain, private_key, grpc_keep_alive_timeout, table_client_settings, primary_user_agent
2430

2531

26-
AsyncIO
27-
~~~~~~~~~~~~~
32+
Driver (AsyncIO)
33+
^^^^^^^^^^^^^^^
2834

2935
.. autoclass:: ydb.aio.Driver
3036
:members:
3137
:inherited-members:
3238
:undoc-members:
3339

34-
3540
------------------------
3641

3742
Common
3843
-------------
3944

45+
BaseRequestSettings
46+
^^^^^^^^^^^^^^^^^^^
47+
4048
.. autoclass:: ydb.BaseRequestSettings
4149
:members:
4250
:inherited-members:
4351
:undoc-members:
4452

53+
54+
Result Sets
55+
^^^^^^^^^^^
56+
57+
.. autoclass:: ydb.convert._ResultSet
58+
:members:
59+
:inherited-members:
60+
:undoc-members:
61+
62+
4563
------------------------
4664

4765
Query Service
4866
-------------
4967

68+
QueryClientSettings
69+
^^^^^^^^^^^^^^^^^^^
70+
71+
.. autoclass:: ydb.QueryClientSettings
72+
:members:
73+
:inherited-members:
74+
:undoc-members:
75+
76+
77+
QuerySessionPool
78+
^^^^^^^^^^^^^^^^
79+
5080
.. autoclass:: ydb.QuerySessionPool
5181
:members:
5282
:inherited-members:
5383
:undoc-members:
5484

85+
QuerySession
86+
^^^^^^^^^^^^
5587

5688
.. autoclass:: ydb.QuerySession
5789
:members:
5890
:inherited-members:
5991
:undoc-members:
6092

6193

94+
QueryTxContext
95+
^^^^^^^^^^^^^^
96+
6297
.. autoclass:: ydb.QueryTxContext
6398
:members:
6499
:inherited-members:
65100
:undoc-members:
66101

67102

68-
AsyncIO
69-
~~~~~~~
103+
QuerySessionPool (AsyncIO)
104+
^^^^^^^^^^^^^^^^^^^^^^^^^^
70105

71106
.. autoclass:: ydb.aio.QuerySessionPool
72107
:members:
73108
:inherited-members:
74109
:undoc-members:
75110

111+
112+
QuerySession (AsyncIO)
113+
^^^^^^^^^^^^^^^^^^^^^^
114+
76115
.. autoclass:: ydb.aio.QuerySession
77116
:members:
78117
:inherited-members:
79118
:undoc-members:
80119

120+
121+
QueryTxContext (AsyncIO)
122+
^^^^^^^^^^^^^^^^^^^^^^^^
123+
81124
.. autoclass:: ydb.aio.QueryTxContext
82125
:members:
83126
:inherited-members:
@@ -150,12 +193,3 @@ SchemeClient
150193

151194
------------------
152195

153-
Result Sets
154-
-----------
155-
156-
.. autoclass:: ydb.convert._ResultSet
157-
:members:
158-
:inherited-members:
159-
:undoc-members:
160-
161-
-----------------------------

0 commit comments

Comments
 (0)