restructure docs

ydb-platform · Sep 10, 2024 · 0581a10 · 0581a10
1 parent c56fbce
commit 0581a10
Showing 1 changed file with 41 additions and 8 deletions.
diff --git a/docs/apireference.rst b/docs/apireference.rst
@@ -10,33 +10,41 @@ YDB API Reference
 Driver
 ------
 
-.. autoclass:: ydb.Driver
+DriverConfig
+^^^^^^^^^^^^
+
+.. autoclass:: ydb.DriverConfig
     :members:
     :inherited-members:
     :undoc-members:
+    :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
 
 
-.. autoclass:: ydb.DriverConfig
+Driver
+^^^^^^
+
+.. autoclass:: ydb.Driver
     :members:
     :inherited-members:
     :undoc-members:
-    :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
 
 
-AsyncIO
-~~~~~~~~~~~~~
+Driver (AsyncIO)
+^^^^^^^^^^^^^^^
 
 .. autoclass:: ydb.aio.Driver
     :members:
     :inherited-members:
     :undoc-members:
 
-
 ------------------------
 
 Common
 -------------
 
+BaseRequestSettings
+^^^^^^^^^^^^^^^^^^^
+
 .. autoclass:: ydb.BaseRequestSettings
     :members:
     :inherited-members:
@@ -47,37 +55,62 @@ Common
 Query Service
 -------------
 
+QueryClientSettings
+^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ydb.QueryClientSettings
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+
+QuerySessionPool
+^^^^^^^^^^^^^^^^
+
 .. autoclass:: ydb.QuerySessionPool
     :members:
     :inherited-members:
     :undoc-members:
 
+QuerySession
+^^^^^^^^^^^^
 
 .. autoclass:: ydb.QuerySession
     :members:
     :inherited-members:
     :undoc-members:
 
 
+QueryTxContext
+^^^^^^^^^^^^^^
+
 .. autoclass:: ydb.QueryTxContext
     :members:
     :inherited-members:
     :undoc-members:
 
 
-AsyncIO
-~~~~~~~
+QuerySessionPool (AsyncIO)
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: ydb.aio.QuerySessionPool
     :members:
     :inherited-members:
     :undoc-members:
 
+
+QuerySession (AsyncIO)
+^^^^^^^^^^^^^^^^^^^^^^
+
 .. autoclass:: ydb.aio.QuerySession
     :members:
     :inherited-members:
     :undoc-members:
 
+
+QueryTxContext (AsyncIO)
+^^^^^^^^^^^^^^^^^^^^^^^^
+
 .. autoclass:: ydb.aio.QueryTxContext
     :members:
     :inherited-members: