add soft transfer

.readthedocs.yml

@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

README.md

@@ -5,87 +5,9 @@ A Sphinx extension that generates a summary `llms.txt` file, written in Markdown
 [![PyPI version](https://img.shields.io/pypi/v/sphinx-llms-txt.svg)](https://pypi.python.org/pypi/sphinx-llms-txt)
 [![Downloads](https://static.pepy.tech/badge/sphinx-llms-txt/month)](https://pepy.tech/project/sphinx-llms-txt)
 
-## Installation
+## Documentation
 
-```bash
-pip install sphinx-llms-txt
-```
-
-## Usage
-
-1. Add the extension to your Sphinx configuration (`conf.py`):
-
-```python
-extensions = [
-    'sphinx_llms_txt',
-]
-```
-
-## Configuration Options
-
-### `llms_txt_full_file`
-
-- **Type**: boolean
-- **Default**: `'True'`
-- **Description**: Whether to write the single output file
-
-### `llms_txt_full_filename`
-
-- **Type**: string
-- **Default**: `'llms-full.txt'`
-- **Description**: Name of the single output file
-
-### `llms_txt_full_max_size`
-
-- **Type**: integer or `None`
-- **Default**: `None` (no limit)
-- **Description**: Sets a maximum line count for `llms_txt_full_filename`.
-  If exceeded, the file is skipped and a warning is shown, but the build still completes.
-
-### `llms_txt_file`
-
-- **Type**: boolean
-- **Default**: `True`
-- **Description**: Whether to write the summary information file
-
-### `llms_txt_filename`
-
-- **Type**: string
-- **Default**: `llms.txt`
-- **Description**: Name of the summary information file
-
-### `llms_txt_directives`
-
-- **Type**: list of strings
-- **Default**: `[]`
-- **Description**: List of custom directive names to process for path resolution.
-
-### `llms_txt_title`
-
-- **Type**: string or `None`
-- **Default**: `None`
-- **Description**: Overrides the Sphinx project name as the heading in `llms.txt`.
-
-### `llms_txt_summary`
-
-- **Type**: string or `None`
-- **Default**: `None`
-- **Description**: Optional, but recommended, summary description for `llms.txt`.
-
-### `llms_txt_exclude`
-
-- **Type**: list of strings
-- **Default**: `[]`
-- **Description**: A list of pages to ignore  (e.g., `["page1", "page_with_*"]`).
-
-## 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
+See [sphinx-llms-txt documentation](https://sphinx-llms-txt.readthedocs.io/en/latest/index.html) for installation and configuration instructions.
 
 ## License
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = SphinxLLMsTxt
+SOURCEDIR     = source
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/requirements.txt

@@ -0,0 +1,6 @@
+furo
+esbonio
+sphinx-contributors
+sphinx
+sphinx-llms-txt
+sphinxext-opengraph

docs/source/advanced-configuration.rst

@@ -0,0 +1,170 @@
+Advanced Configuration
+======================
+
+This page covers advanced configuration options for the sphinx-llms-txt extension.
+
+.. _customizing_llms_files:
+
+Customizing the LLMs Files
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+By default, the extension generates two files:
+
+1. ``llms.txt`` - A summary file in Markdown format
+2. ``llms-full.txt`` - A complete documentation file in reStructuredText format
+
+You can customize these files in several ways:
+
+.. _changing_filenames:
+
+Changing Filenames
+~~~~~~~~~~~~~~~~~~
+
+You can change the default filenames by setting these values in your ``conf.py``:
+
+.. code-block:: python
+
+   llms_txt_filename = "custom-summary.txt"
+   llms_txt_full_filename = "custom-docs.txt"
+
+.. _disabling_file_generation:
+
+Disabling File Generation
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you only want one of the files, you can disable generation of the other:
+
+.. code-block:: python
+
+   # Disable summary file
+   llms_txt_file = False
+
+   # Disable full documentation file
+   llms_txt_full_file = False
+
+.. _custom_summary:
+
+Adding a Custom Summary
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The summary file can include a custom description of your project:
+
+.. code-block:: python
+
+   llms_txt_summary = """
+   This documentation explains how to use MyProject to build amazing
+   applications. The project provides a comprehensive API for handling
+   data processing and visualization.
+   """
+
+.. note:: The summary can span multiple lines and will be properly formatted in the output file.
+
+.. _custom_title:
+
+Custom Title
+~~~~~~~~~~~~
+
+By default, the project name from Sphinx is used as the title in ``llms.txt``. You can override this:
+
+.. code-block:: python
+
+   llms_txt_title = "My Custom Project Documentation"
+
+.. _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:
+
+.. code-block:: python
+
+   llms_txt_full_max_size = 10000  # Maximum 10,000 lines
+
+If the generated file would exceed this limit, the extension will skip its generation and show a warning, allowing the build to complete.
+
+.. tip:: Use :ref:`excluding_content` to remove less relevant pages.
+
+.. _custom_directive_handling:
+
+Custom Directive Handling
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. _path_resolution:
+
+Path Resolution
+~~~~~~~~~~~~~~~
+
+The extension resolves paths in the common directives ``[ 'image', 'figure']`` by default.
+You can add custom directives to this list:
+
+.. code-block:: python
+
+   llms_txt_directives = [
+       "my-custom-image-directive",
+       "another-directive-with-paths",
+   ]
+
+This ensures that paths in your custom directives are properly resolved in the generated files.
+
+.. _excluding_content:
+
+Excluding Content
+^^^^^^^^^^^^^^^^^
+
+You can exclude specific pages from being included in the generated files:
+
+.. code-block:: python
+
+   llms_txt_exclude = [
+       "search",  # Exclude the search page
+       "genindex",  # Exclude the index page
+       "private_*",  # Exclude all pages starting with 'private_'
+   ]
+
+This is useful for excluding auto-generated pages, indexes, or content that isn't relevant for LLM consumption.
+
+.. _using_html_baseurl:
+
+Using HTML Base URL
+^^^^^^^^^^^^^^^^^^^
+
+If you want to include absolute URLs for resources in your documentation, you can use Sphinx's built-in ``html_baseurl`` configuration:
+
+.. code-block:: python
+
+   html_baseurl = "https://example.com/docs/"
+
+When this option is set, all resolved paths in directives will be prefixed with this URL, creating absolute paths in the generated files.
+
+.. _integration_examples:
+
+Integration Examples
+^^^^^^^^^^^^^^^^^^^^
+
+Complete Configuration Example
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Here's a complete example showing multiple configuration options:
+
+.. code-block:: python
+
+   # File names and generation options
+   llms_txt_filename = "ai-summary.txt"
+   llms_txt_full_filename = "ai-full-docs.txt"
+   llms_txt_full_max_size = 50000
+
+   # Content customization
+   llms_txt_title = "Project Documentation for AI Assistants"
+   llms_txt_summary = """
+   This is a comprehensive documentation set for our project.
+   It includes API references, usage examples, and tutorials.
+   """
+
+   # Path handling
+   html_baseurl = "https://docs.example.com/"
+   llms_txt_directives = ["custom-image", "custom-include"]
+
+   # Content filtering
+   llms_txt_exclude = ["search", "genindex", "404", "private_*"]

docs/source/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../../CHANGELOG.rst

docs/source/conf.py

@@ -0,0 +1,101 @@
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+import re
+import subprocess
+
+# -- Project information -----------------------------------------------------
+
+project = "sphinx-llms-txt"
+copyright = "Jared Dillard"
+author = "Jared Dillard"
+llms_txt_summary = """
+A Sphinx extension that generates a summary llms.txt file,written in Markdown,
+and a single combined documentation llms-full.txt file, written in reStructuredText.
+"""
+
+# check if the current commit is tagged as a release (vX.Y.Z)
+try:
+    GIT_TAG_OUTPUT = subprocess.check_output(["git", "tag", "--points-at", "HEAD"])
+    current_tag = GIT_TAG_OUTPUT.decode().strip()
+    if re.match(r"^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", current_tag):
+        version = current_tag
+    else:
+        version = "latest"
+except (subprocess.CalledProcessError, FileNotFoundError):
+    version = "latest"
+
+# The full version, including alpha/beta/rc tags
+release = ""
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.intersphinx",
+    "sphinx_contributors",
+    "sphinx_llms_txt",
+]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+intersphinx_mapping = {
+    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
+}
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "furo"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {}
+
+html_baseurl = "https://sphinx-llms-txt.readthedocs.org/"
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "SphinxLLMsTxtdoc"
+
+
+def setup(app):
+    app.add_object_type(
+        "confval",
+        "confval",
+        objname="configuration value",
+        indextemplate="pair: %s; configuration value",
+    )

docs/source/configuration-values.rst

@@ -0,0 +1,84 @@
+Project Configuration Values
+============================
+
+.. confval:: llms_txt_full_file
+
+   - **Type**: boolean
+   - **Default**: ``True``
+   - **Description**: Whether to write the single output file.
+     See :ref:`disabling_file_generation`.
+
+   .. versionadded:: 0.1.0
+
+.. confval:: llms_txt_full_filename
+
+   - **Type**: string
+   - **Default**: ``'llms-full.txt'``
+   - **Description**: Name of the single output file.
+     See :ref:`changing_filenames`.
+
+   .. versionadded:: 0.1.0
+
+.. confval:: llms_txt_full_max_size
+
+   - **Type**: integer or ``None``
+   - **Default**: ``None`` (no limit)
+   - **Description**: Sets a maximum line count for ``llms_txt_full_filename``.
+     If exceeded, the file is skipped and a warning is shown, but the build still completes.
+     See :ref:`handling_large_documentation`.
+
+   .. versionadded:: 0.2.0
+
+.. confval:: llms_txt_file
+
+   - **Type**: boolean
+   - **Default**: ``True``
+   - **Description**: Whether to write the summary information file.
+     See :ref:`disabling_file_generation`.
+
+   .. versionadded:: 0.2.0
+
+.. confval:: llms_txt_filename
+
+   - **Type**: string
+   - **Default**: ``llms.txt``
+   - **Description**: Name of the summary information file.
+     See :ref:`changing_filenames`.
+
+   .. versionadded:: 0.2.0
+
+.. confval:: llms_txt_directives
+
+   - **Type**: list of strings
+   - **Default**: ``[]`` (empty list)
+   - **Description**: List of custom directive names to process for path resolution.
+     See :ref:`path_resolution`.
+
+   .. versionadded:: 0.1.0
+
+.. confval:: llms_txt_title
+
+   - **Type**: string or ``None``
+   - **Default**: ``None``
+   - **Description**: Overrides the Sphinx project name as the heading in ``llms.txt``.
+     See :ref:`custom_title`.
+
+   .. versionadded:: 0.2.0
+
+.. confval:: llms_txt_summary
+
+   - **Type**: string or ``None``
+   - **Default**: ``None``
+   - **Description**: Optional, but recommended, summary description for ``llms.txt``.
+     See :ref:`custom_summary`.
+
+   .. versionadded:: 0.2.0
+
+.. confval:: llms_txt_exclude
+
+   - **Type**: list of strings
+   - **Default**: ``[]``
+   - **Description**: A list of pages to ignore.
+     See :ref:`excluding_content`.
+
+   .. versionadded:: 0.2.1

docs/source/contributing.rst

@@ -0,0 +1,48 @@
+Contributing
+============
+
+You will need to set up a development environment to make and test your changes before submitting them.
+
+Local development
+-----------------
+
+#. Clone the `sphinx-llms-txt repository`_.
+
+#. Create and activate a virtual environment:
+
+   .. code-block:: console
+
+      python3 -m venv .venv
+      source .venv/bin/activate
+
+#. Install development dependencies:
+
+   .. code-block:: console
+
+      pip install -e ".[dev]"
+
+#. Install pre-commit Git hook scripts:
+
+   .. code-block:: console
+
+      pre-commit install
+
+Testing changes
+---------------
+
+Run ``pytest`` before committing changes.
+
+Current contributors
+--------------------
+
+Thanks to all who have contributed!
+The people that have improved the code:
+
+.. contributors:: jdillard/sphinx-llms-txt
+   :avatars:
+   :limit: 100
+   :exclude: pre-commit-ci[bot],dependabot[bot]
+   :order: ASC
+
+
+.. _sphinx-llms-txt repository: https://github.com/jdillard/sphinx-llms-txt

docs/source/getting-started.rst

@@ -0,0 +1,50 @@
+Getting Started
+===============
+
+Demo
+----
+
+You can see this Sphinx project's `llms.txt`_ and `llms-full.txt`_ files as a simple example.
+
+Installation
+------------
+
+Directly install via ``pip`` by using:
+
+.. code-block:: bash
+
+    pip install sphinx-llms-txt
+
+Usage
+-----
+
+Add the extension to your Sphinx configuration (``conf.py``):
+
+.. code-block:: python
+
+    extensions = [
+        'sphinx_llms_txt',
+    ]
+
+Once added, the extension will automatically generate the LLMs.txt files during the build process.
+
+See :doc:`advanced-configuration` for more information about how to use **sphinx-llms-txt**.
+
+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

docs/source/index.rst

@@ -0,0 +1,22 @@
+Sphinx llms.txt Generator
+=========================
+
+A `Sphinx`_ extension that generates a summary ``llms.txt`` file, written in Markdown, and a single combined documentation ``llms-full.txt`` file, written in reStructuredText.
+
+|PyPI version|
+
+.. toctree::
+   :maxdepth: 2
+
+   getting-started
+   advanced-configuration
+   configuration-values
+   contributing
+   changelog
+
+
+.. _Sphinx: http://sphinx-doc.org/
+
+.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-llms-txt.svg
+   :target: https://pypi.python.org/pypi/sphinx-llms-txt
+   :alt: Latest PyPi Version

sphinx_llms_txt/writer.py

@@ -86,6 +86,11 @@ class FileWriter:
                 # Add description if available
                 description = self.config.get("llms_txt_summary", "")
                 if description:
+                    # Trim leading and trailing whitespace
+                    description = description.strip()
+                    # Replace newlines with newline + blockquote marker to maintain
+                    # blockquote formatting
+                    description = description.replace("\n", "\n> ")
                     f.write(f"> {description}\n\n")
 
                 f.write("## Docs\n\n")