Add advanced configuration

This commit is contained in:
Jared Dillard
2025-05-18 20:47:58 -07:00
parent da48421b03
commit 2f62461703
3 changed files with 37 additions and 33 deletions
+21
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,19 @@ Add the extension to your Sphinx configuration (``conf.py``):
]
Once added, the extension will automatically generate the LLMs.txt files during the build process.
Features
--------
Sphinx LLMs.txt provides the following features:
- Creates ``llms.txt`` and ``llms-full.txt``
- Automatically add content from ``include`` directives
- Resolves relative paths in directives like ``image`` and ``figure`` to use full paths
- Ability to add list of custom directives with ``llms_txt_directives``
- Optionally, prepend a base URL using Sphinx's ``html_baseurl``
- Ability to exclude pages
.. _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