Skip to content

Commit 0581a10

Browse files
committed
restructure docs
1 parent c56fbce commit 0581a10

File tree

1 file changed

+41
-8
lines changed

1 file changed

+41
-8
lines changed

docs/apireference.rst

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,41 @@ 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:
@@ -47,37 +55,62 @@ Common
4755
Query Service
4856
-------------
4957

58+
QueryClientSettings
59+
^^^^^^^^^^^^^^^^^^^
60+
61+
.. autoclass:: ydb.QueryClientSettings
62+
:members:
63+
:inherited-members:
64+
:undoc-members:
65+
66+
67+
QuerySessionPool
68+
^^^^^^^^^^^^^^^^
69+
5070
.. autoclass:: ydb.QuerySessionPool
5171
:members:
5272
:inherited-members:
5373
:undoc-members:
5474

75+
QuerySession
76+
^^^^^^^^^^^^
5577

5678
.. autoclass:: ydb.QuerySession
5779
:members:
5880
:inherited-members:
5981
:undoc-members:
6082

6183

84+
QueryTxContext
85+
^^^^^^^^^^^^^^
86+
6287
.. autoclass:: ydb.QueryTxContext
6388
:members:
6489
:inherited-members:
6590
:undoc-members:
6691

6792

68-
AsyncIO
69-
~~~~~~~
93+
QuerySessionPool (AsyncIO)
94+
^^^^^^^^^^^^^^^^^^^^^^^^^^
7095

7196
.. autoclass:: ydb.aio.QuerySessionPool
7297
:members:
7398
:inherited-members:
7499
:undoc-members:
75100

101+
102+
QuerySession (AsyncIO)
103+
^^^^^^^^^^^^^^^^^^^^^^
104+
76105
.. autoclass:: ydb.aio.QuerySession
77106
:members:
78107
:inherited-members:
79108
:undoc-members:
80109

110+
111+
QueryTxContext (AsyncIO)
112+
^^^^^^^^^^^^^^^^^^^^^^^^
113+
81114
.. autoclass:: ydb.aio.QueryTxContext
82115
:members:
83116
:inherited-members:

0 commit comments

Comments
 (0)