From 1ba2c28c372bbf486ab44d425151a70cf7bf6161 Mon Sep 17 00:00:00 2001 From: Oleg Ovcharuk Date: Wed, 20 May 2026 14:58:27 +0300 Subject: [PATCH] Add llms.txt documentation support --- docs/conf.py | 10 ++++++++++ docs/index.rst | 9 +++++++++ docs/requirements.txt | 1 + 3 files changed, 20 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 13d7e22da..a13337e5e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. @@ -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. diff --git a/docs/index.rst b/docs/index.rst index cbe2c5ddb..4a3810ff3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 `_ +as the documentation index and +`llms-full.txt `_ +as the complete documentation context. + + Running Queries --------------- diff --git a/docs/requirements.txt b/docs/requirements.txt index f8306480f..5338e8ce0 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ sphinx_rtd_theme==2.0.0 sphinx-copybutton==0.5.2 +sphinx-llms-txt==0.7.1