Skip to content

fix docs #894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vgvoleg merged 2 commits into from
Sep 7, 2026
Merged

fix docs #894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4182c6f
fix docs
Khabib73 Sep 6, 2026
4d6cf38
use html_show_sphinx
Khabib73 Sep 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,18 +83,12 @@
#
html_theme = 'sphinx_rtd_theme'

html_theme_options = {
'fixed_sidebar': True,
'page_width': '1140px',
'show_related': True,
'show_powered_by': False
}

html_logo = '_static/logo.svg'
html_favicon = '_static/logo.svg'
html_baseurl = 'https://ydb-platform.github.io/ydb-python-sdk/'

html_show_sourcelink = False
html_show_sphinx = False

llms_txt_title = 'YDB Python SDK Documentation'
llms_txt_summary = '''
Expand Down
12 changes: 6 additions & 6 deletions docs/driver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ AnonymousCredentials
^^^^^^^^^^^^^^^^^^^^

No authentication. Use for local or unauthenticated deployments
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/anonymous-credentials>`_):
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/anonymous-credentials>`__):

.. code-block:: python

Expand All @@ -176,7 +176,7 @@ AccessTokenCredentials
^^^^^^^^^^^^^^^^^^^^^^

Pass a static IAM token or API key directly
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/access-token-credentials>`_):
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/access-token-credentials>`__):

.. code-block:: python

Expand All @@ -185,7 +185,7 @@ Pass a static IAM token or API key directly
StaticCredentials (username/password)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/static-credentials>`_)
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/static-credentials>`__)

.. code-block:: python

Expand All @@ -196,7 +196,7 @@ Service Account Credentials

Authenticate as a Yandex Cloud service account using a key file. Requires the ``ydb[yc]``
extra (``pip install ydb[yc]``)
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/service-account-credentials>`_):
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/service-account-credentials>`__):

.. code-block:: python

Expand All @@ -212,7 +212,7 @@ Metadata Credentials

Picks up credentials from the instance metadata service when running inside Yandex Cloud
(Compute VM, Cloud Functions, etc.). Requires ``ydb[yc]``
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/metadata-credentials>`_):
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/metadata-credentials>`__):

.. code-block:: python

Expand All @@ -225,7 +225,7 @@ OAuth 2.0 Token Exchange

For federated identity scenarios. Exchanges a subject token (e.g. a signed JWT) for a
YDB access token via an OAuth 2.0 token exchange endpoint
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/oauth2-token-exchange-credentials>`_):
(`full example <https://github.com/ydb-platform/ydb-python-sdk/tree/main/examples/oauth2-token-exchange-credentials>`__):

.. code-block:: python

Expand Down
Loading