Merge pull request #479 from ydb-platform/autogenetated_docs

autogenerated docs

.github/workflows/docs.yml

@@ -0,0 +1,18 @@
+name: Deploy Sphinx documentation to Github Pages
+
+on:
+  push:
+    branches: [main] # branch to trigger deployment
+
+jobs:
+  pages:
+    runs-on: ubuntu-20.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3

README.md

@@ -7,6 +7,12 @@ YDB Python SDK
 
 Officially supported Python client for YDB.
 
+---
+
+**Documentation**: <a href="https://ydb-platform.github.io/ydb-python-sdk" target="_blank">https://ydb-platform.github.io/ydb-python-sdk</a>
+
+---
+
 ## Quickstart
 
 ### Prerequisites

docs/apireference.rst

@@ -0,0 +1,244 @@
+YDB API Reference
+=================
+
+.. toctree::
+   :caption: Contents:
+
+
+.. module:: 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
+
+
+Driver
+^^^^^^
+
+.. autoclass:: ydb.Driver
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+
+Driver (AsyncIO)
+^^^^^^^^^^^^^^^
+
+.. autoclass:: ydb.aio.Driver
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+------------------------
+
+Common
+-------------
+
+BaseRequestSettings
+^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ydb.BaseRequestSettings
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :exclude-members: trace_id, request_type, timeout, cancel_after, operation_timeout, compression, need_rpc_auth, headers, make_copy, tracer
+
+
+RetrySettings
+^^^^^^^^^^^^^
+
+.. autoclass:: ydb.RetrySettings
+    :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:
+
+
+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:
+
+
+Query Tx Mode
+^^^^^^^^^^^^^
+
+.. autoclass:: ydb.BaseQueryTxMode
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :exclude-members: name, to_proto
+
+
+.. autoclass:: ydb.QueryOnlineReadOnly
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :exclude-members: name, to_proto
+
+
+.. autoclass:: ydb.QuerySerializableReadWrite
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :exclude-members: name, to_proto
+
+
+.. autoclass:: ydb.QuerySnapshotReadOnly
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :exclude-members: name, to_proto
+
+
+.. autoclass:: ydb.QueryStaleReadOnly
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :exclude-members: name, to_proto
+
+
+------------------------
+
+Table Service
+-------------
+
+TableClient
+^^^^^^^^^^^
+.. autoclass:: ydb.TableClient
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+TableClientSettings
+^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ydb.TableClientSettings
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+Session Pool
+^^^^^^^^^^^^
+
+.. autoclass:: ydb.SessionPool
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+Session
+^^^^^^^
+
+.. autoclass:: ydb.Session
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+Transaction Context
+^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ydb.TxContext
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+DataQuery
+^^^^^^^^^
+
+.. autoclass:: ydb.DataQuery
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+--------------------------
+
+Scheme
+------
+
+SchemeClient
+^^^^^^^^^^^^
+
+.. autoclass:: ydb.SchemeClient
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+------------------
+

docs/conf.py

@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'ydb'
-copyright = '2021, yandex'
+copyright = '2024, yandex'
 author = 'yandex'
 
 # The short X.Y version
@@ -39,11 +39,12 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-            'sphinx.ext.autodoc',
-            'sphinx.ext.viewcode',
-            'sphinx.ext.todo',
-            'sphinx.ext.napoleon',
-            'sphinx.ext.coverage',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.todo',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.coverage',
+    'sphinx_copybutton',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -79,15 +80,20 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 html_theme_options = {
-            'fixed_sidebar': True,
-            'page_width': '1140px',
-            'show_related': True,
-            'show_powered_by': False
+    'fixed_sidebar': True,
+    'page_width': '1140px',
+    'show_related': True,
+    'show_powered_by': False
 }
 
+html_logo = '_static/logo.svg'
+html_favicon = '_static/logo.svg'
+
+html_show_sourcelink = False
+
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
@@ -97,7 +103,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['.static']
+html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.