From 7e390546ba0c13fda5958297b6ce86c11c13628d Mon Sep 17 00:00:00 2001 From: Jared Dillard Date: Sun, 10 Aug 2025 14:53:56 -0700 Subject: [PATCH] Improve docstring --- sphinx_llms_txt/__init__.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/sphinx_llms_txt/__init__.py b/sphinx_llms_txt/__init__.py index c09f172..ca56d77 100644 --- a/sphinx_llms_txt/__init__.py +++ b/sphinx_llms_txt/__init__.py @@ -1,5 +1,14 @@ """ -Sphinx extension to create a combined sources file (llms-full.txt) +Sphinx extension that generates llms.txt and llms-full.txt files for LLM consumption. + +This extension collects documentation content from Sphinx projects and generates +two output files: +- llms.txt: A concise Markdown summary with project overview and page links +- llms-full.txt: A comprehensive reStructuredText file containing all documentation + content with resolved includes and path references + +The extension processes content during the build phase, handles page-level and +block-level ignore directives, and can optionally include source code files. """ from typing import Any, Dict