Update docs and README (#17)

* Move readme content to index.rst

* Clean up project name

* Add advanced configuration
This commit is contained in:
Jared Dillard
2025-05-18 21:10:49 -07:00
committed by GitHub
parent da7ee68076
commit 8f4d2c07c6
6 changed files with 212 additions and 113 deletions
+24
View File
@@ -1,6 +1,11 @@
Getting Started
===============
Demo
----
You can see this Sphinx project's `llms.txt`_ and `llms-full.txt`_ files as a simple example.
Installation
------------
@@ -22,3 +27,22 @@ Add the extension to your Sphinx configuration (``conf.py``):
]
Once added, the extension will automatically generate the LLMs.txt files during the build process.
How It Works
-----------
During the Sphinx build process:
1. **Content Collection**: Scans all of your documentation's ``_source`` pages and collects their content
2. **Directive Processing**: Resolves ``include`` directives by automatically incorporating their content
3. **Path Resolution**: Transforms relative paths in directives to full paths
4. **Output Generation**: Creates two optional files:
- ``llms.txt``: A concise summary of your documentation, in Markdown
- ``llms-full.txt``: A comprehensive version with all documentation content, in reStructuredText
5. **Content Filtering**: Allows you to exclude specific pages from the generated files
.. _llms.txt: https://sphinx-llms-txt.readthedocs.io/en/latest/llms.txt
.. _llms-full.txt: https://sphinx-llms-txt.readthedocs.io/en/latest/llms-full.txt