From b2aa7897d3ef64603928735ab600e6a6534b95bb Mon Sep 17 00:00:00 2001 From: Jared Dillard Date: Sun, 18 May 2025 21:08:58 -0700 Subject: [PATCH] Clean up --- docs/source/advanced-configuration.rst | 6 ++++-- docs/source/getting-started.rst | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/source/advanced-configuration.rst b/docs/source/advanced-configuration.rst index 73b2d1a..bc77e21 100644 --- a/docs/source/advanced-configuration.rst +++ b/docs/source/advanced-configuration.rst @@ -75,7 +75,8 @@ By default, the project name from Sphinx is used as the title in ``llms.txt``. Y 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 @@ -95,7 +96,8 @@ Custom Directive Handling 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 diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 6184670..c796419 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -35,8 +35,8 @@ 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 like ``image`` and ``figure`` to full paths -4. **Output Generation**: Creates two files: +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