sphinx-llm

What it is and what it does

sphinx-llm is a collection of Sphinx extensions designed to bridge documentation and large language models. It serves two main purposes: making your documentation easily consumable by LLMs and agents (via the llms.txt standard), and optionally using LLMs to generate documentation content during the build process.

The package's primary extension generates llms.txt-compliant output alongside your HTML documentation. During each build, it produces markdown versions of your pages, a sitemap file (llms.txt), and a concatenated full-text file (llms-full.txt) that LLMs and agents can index and retrieve. It supports multiple markdown naming schemes (file-suffix, URL-suffix, or replace modes) and works with both html and dirhtml builders. Optional LLM-powered features can generate page summaries using OpenAI-compatible endpoints, with caching and configurable timeouts.

Use it for:

• Make your project documentation discoverable and well-indexed when users query LLMs about your domain or project.
• Generate llms.txt and llms-full.txt files for consumption by AI agents that gather context from web documentation.
• Automatically produce markdown versions of HTML pages for LLM training or retrieval-augmented generation (RAG) systems.
• Generate one-sentence page summaries using an LLM provider to populate llms.txt entries without manual authoring.
• Export Sphinx documentation in a format compatible with Claude and other LLM documentation standards.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Sphinx extensions that generate LLM-consumable documentation formats (llms.txt standard) and optionally use LLMs to generate content during the Sphinx build process.

Yes, if you maintain Sphinx documentation and want it indexed by LLMs or consumed by AI agents. The package is active, well-maintained, has low install friction, and carries a permissive license. It is beta-status software (Development Status 4), so expect potential API changes, but it has no known vulnerabilities and supports current Python versions. Install it if LLM-friendly documentation export is a goal; skip it if you have no such use case.

Install

sphinx-llm on PyPI

pip install sphinx-llm

uv add sphinx-llm

poetry add sphinx-llm

Installing sphinx-llm

Before you install

Low install friction with a pure-Python wheel. Actively maintained as of 2026-08-14 with recent release. Supports Python 3.9 through 3.14 and PyPy.

License in practice

Apache License 2.0 is permissive; you may use, modify, and distribute this package and derivative works freely, provided you include license notices and state changes.

Quickstart

pip install sphinx-llm

# In conf.py:
extensions = [
    "sphinx_llm.txt",
]

# Then run: sphinx-build -b html source _build/html
# Generates llms.txt, llms-full.txt, and .md versions of each page

Requires Sphinx and sphinx-markdown-builder as runtime dependencies; only works with HTML builders (html, dirhtml).

Verify before relying

• Whether LLM content generation features (the [gen] extra) require additional system dependencies beyond Python packages.
• Performance impact of parallel markdown building on large documentation sites.
• Compatibility with custom Sphinx themes or non-standard builder configurations.

Package facts

Evidence: sphinx_llm-1.0.0-py3-none-any.whl

Tags

More Sphinx packages