restructure docs

ydb-platform · Sep 10, 2024 · 52b9587 · 52b9587
1 parent c56fbce
commit 52b9587
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 18 deletions.
diff --git a/docs/apireference.rst b/docs/apireference.rst
@@ -10,79 +10,123 @@ 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:
     :undoc-members:
 
+
+Result Sets
+^^^^^^^^^^^
+
+.. autoclass:: ydb.convert._ResultSet
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+
 ------------------------
 
 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:
     :undoc-members:
 
+
 ------------------------
 
 Table Service
@@ -150,12 +194,3 @@ SchemeClient
 
 ------------------
 
-Result Sets
------------
-
-.. autoclass:: ydb.convert._ResultSet
-   :members:
-   :inherited-members:
-   :undoc-members:
-
------------------------------
diff --git a/ydb/aio/__init__.py b/ydb/aio/__init__.py
@@ -1,3 +1,3 @@
 from .driver import Driver  # noqa
 from .table import SessionPool, retry_operation  # noqa
-from .query import QuerySessionPool, QuerySession  # noqa
+from .query import QuerySessionPool, QuerySession, QueryTxContext  # noqa