Skip to content

Commit

Permalink
restructure docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vgvoleg committed Sep 10, 2024
1 parent c56fbce commit 34c0aa1
Showing 1 changed file with 52 additions and 17 deletions.
69 changes: 52 additions & 17 deletions docs/apireference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
^^^^^^^^^^^^^^^

Check warning on line 33 in docs/apireference.rst

View workflow job for this annotation

GitHub Actions / pages

Title underline too short.

Check warning on line 33 in docs/apireference.rst

View workflow job for this annotation

GitHub Actions / pages

Title underline too short.

.. 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
Expand Down Expand Up @@ -150,12 +194,3 @@ SchemeClient

------------------

Result Sets
-----------

.. autoclass:: ydb.convert._ResultSet
:members:
:inherited-members:
:undoc-members:

-----------------------------

0 comments on commit 34c0aa1

Please sign in to comment.