From 19c224c199cfff4119715b49434f6d8e304d16dd Mon Sep 17 00:00:00 2001 From: Jared Dillard Date: Sat, 9 Aug 2025 01:39:06 -0700 Subject: [PATCH 1/3] Add contributing to README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 589a710..168e7e4 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,13 @@ A Sphinx extension that generates a summary `llms.txt` file and a single combine See [sphinx-llms-txt documentation](https://sphinx-llms-txt.readthedocs.io/en/latest/index.html) for installation and configuration instructions. +## Contributing + +Pull Requests welcome! See `Contributing`_ for instructions on how best to contribute. + ## License MIT License - see LICENSE file for details. + + +.. _Contributing: https://sphinx-llms-txt.readthedocs.io/en/latest/contributing.html From 75380589e10183bdb1ac51b664286bddbbeada4d Mon Sep 17 00:00:00 2001 From: Jared Dillard Date: Sat, 9 Aug 2025 01:40:01 -0700 Subject: [PATCH 2/3] fix syntax --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 168e7e4..307dd7d 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,8 @@ See [sphinx-llms-txt documentation](https://sphinx-llms-txt.readthedocs.io/en/la ## Contributing -Pull Requests welcome! See `Contributing`_ for instructions on how best to contribute. +Pull Requests welcome! See [Contributing](https://sphinx-llms-txt.readthedocs.io/en/latest/contributing.html) for instructions on how best to contribute. ## License MIT License - see LICENSE file for details. - - -.. _Contributing: https://sphinx-llms-txt.readthedocs.io/en/latest/contributing.html From 7e390546ba0c13fda5958297b6ce86c11c13628d Mon Sep 17 00:00:00 2001 From: Jared Dillard Date: Sun, 10 Aug 2025 14:53:56 -0700 Subject: [PATCH 3/3] 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