sphinx-llm
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx and sphinx-markdown-builder as runtime dependencies; only works with HTML builders (html, dirhtml).
- Low install friction with a pure-Python wheel.
- Actively maintained as of 2026-08-14 with recent release.
License · maintenance · safety
permissive license (permissive) — 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.
last release 2026-08-14 (0 days) · last repo commit 2026-08-14 · 37 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 251,463 downloads/mo, #8,582 on PyPI
Alternatives
Verify before relying
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- 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.
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 on it.
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
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.
Requires Sphinx and sphinx-markdown-builder as runtime dependencies; only works with HTML builders (html, dirhtml).
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 pageVerify 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
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagessphinx-markdown-buildersphinx |
| Maintenance | Actively maintained 0 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 251,463 / month, #8,582 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: 3.9Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPy |
Evidence: sphinx_llm-1.0.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx llm documentation”
- sphinx-llmSphinx extensions that generate LLM-consumable documentation formats…
- alabasterAlabaster is a clean, responsive Sphinx theme for documentation that…
- sphinxcontrib-websupportProvides a Python API to integrate Sphinx-generated documentation…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also sphinx-markdown-builder · mkdocs-llmstxt · sphinxcontrib-confluencebuilder · sphinx-sitemap · sphinxemoji · sphinx_mdinclude · autodocsumm · sphinx-markdown-tables · sphinx-jinja