This commit is contained in:
Jared Dillard
2025-05-18 21:08:58 -07:00
parent 12d695015e
commit b2aa7897d3
2 changed files with 6 additions and 4 deletions
+4 -2
View File
@@ -75,7 +75,8 @@ By default, the project name from Sphinx is used as the title in ``llms.txt``. Y
Handling Large Documentation Handling Large Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For very large documentation sets, generating the full documentation file might exceed reasonable size limits. You can set a maximum line count: For very large documentation sets, generating the full documentation file might exceed reasonable size limits.
You can set a maximum line count:
.. code-block:: python .. code-block:: python
@@ -95,7 +96,8 @@ Custom Directive Handling
Path Resolution Path Resolution
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
The extension resolves paths in common directives like ``image`` and ``figure``. You can add custom directives to this list: The extension resolves paths in the common directives ``[ 'image', 'figure']`` by default.
You can add custom directives to this list:
.. code-block:: python .. code-block:: python
+2 -2
View File
@@ -35,8 +35,8 @@ During the Sphinx build process:
1. **Content Collection**: Scans all of your documentation's ``_source`` pages and collects their content 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 2. **Directive Processing**: Resolves ``include`` directives by automatically incorporating their content
3. **Path Resolution**: Transforms relative paths in directives like ``image`` and ``figure`` to full paths 3. **Path Resolution**: Transforms relative paths in directives to full paths
4. **Output Generation**: Creates two files: 4. **Output Generation**: Creates two optional files:
- ``llms.txt``: A concise summary of your documentation, in Markdown - ``llms.txt``: A concise summary of your documentation, in Markdown
- ``llms-full.txt``: A comprehensive version with all documentation content, in reStructuredText - ``llms-full.txt``: A comprehensive version with all documentation content, in reStructuredText