Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
'sphinx.ext.napoleon',
'sphinx.ext.coverage',
'sphinx_copybutton',
'sphinx_llms_txt',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -91,9 +92,18 @@

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

html_show_sourcelink = False

llms_txt_title = 'YDB Python SDK Documentation'
llms_txt_summary = '''
Official Python client documentation for YDB, covering connection setup,
authentication, query execution, topic messaging, table operations,
coordination primitives, error handling, and API reference.
'''
llms_txt_uri_template = '{base_url}{docname}.html'

# 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.
Expand Down
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ SDK is accessed through a ``Driver`` instance, so this page is the foundation fo
everything else.


LLM-ready Documentation
-----------------------

For AI-assisted coding, use `llms.txt <https://ydb-platform.github.io/ydb-python-sdk/llms.txt>`_
as the documentation index and
`llms-full.txt <https://ydb-platform.github.io/ydb-python-sdk/llms-full.txt>`_
as the complete documentation context.


Running Queries
---------------

Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
sphinx_rtd_theme==2.0.0
sphinx-copybutton==0.5.2
sphinx-llms-txt==0.7.1
Loading