sphinx-codeautolink
Automatic links from code examples to reference documentation.
Decision gist · record as of 2026-08-14
Yes, if you maintain Sphinx documentation with code examples and want readers to navigate easily to API references. Low install friction, active maintenance, and no known vulnerabilities make it a safe choice. The Beta status and recommendation to pin versions suggest treating it as a stable but still-evolving tool rather than a mature library.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; sphinx and beautifulsoup4 must be installed.
- Low install friction; depends only on sphinx and beautifulsoup4.
- Actively maintained with a recent release (16 days old) and steady repository activity.
License · maintenance · safety
(unclear)
last release 2026-07-29 (16 days) · last repo commit 2026-07-29 · 72 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 84,218 downloads/mo, #14,015 on PyPI
Alternatives
Verify before relying
pip install sphinx-codeautolink
# In conf.py:
extensions = [
"sphinx_codeautolink",
]- Whether the package handles all Python syntax constructs or only a subset of common patterns
- Performance impact on large documentation builds with many code examples
- Compatibility with Sphinx themes other than the default
What it is and what it does
sphinx-codeautolink is a Sphinx extension that automatically converts code elements in documentation examples into clickable links pointing to their reference documentation. It works by parsing valid Python code in your examples and inserting hyperlinks to the corresponding API docs for each function, class, or module mentioned.
The extension requires minimal setup—just add it to your Sphinx conf.py extensions list—and assumes your code examples are already valid Python. It depends on sphinx and beautifulsoup4 to parse and modify the rendered HTML. The project is in active development (Beta status) and supports Python 3.10 through 3.14, with recent releases and steady maintenance.
Use it for
- Automatically link function and class names in code examples to their API reference documentation
- Make library usage examples in Sphinx docs interactive and navigable without manual link markup
- Reduce documentation maintenance by eliminating hand-written cross-reference links in code blocks
- Improve reader experience by enabling one-click navigation from example code to detailed API docs
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you maintain Sphinx documentation with code examples and want readers to navigate easily to API references.
Low install friction, active maintenance, and no known vulnerabilities make it a safe choice. The Beta status and recommendation to pin versions suggest treating it as a stable but still-evolving tool rather than a mature library.
Install
sphinx-codeautolink on PyPI
Before you install
Low install friction; depends only on sphinx and beautifulsoup4. Actively maintained with a recent release (16 days old) and steady repository activity. Early development status (Beta) suggests version pinning is recommended.
Requires Python 3.10 or later; sphinx and beautifulsoup4 must be installed.
Quickstart
pip install sphinx-codeautolink
# In conf.py:
extensions = [
"sphinx_codeautolink",
]Verify before relying
- Whether the package handles all Python syntax constructs or only a subset of common patterns
- Performance impact on large documentation builds with many code examples
- Compatibility with Sphinx themes other than the default
Package facts
| License | Not declared unclear |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagessphinxbeautifulsoup4 |
| Maintenance | Actively maintained 16 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 84,218 / month, #14,015 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaFramework :: SphinxFramework :: Sphinx :: ExtensionProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Documentation :: SphinxTopic :: Software Development :: Documentation |
Evidence: sphinx_codeautolink-0.19.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 code example linking”
- sphinx-codeautolinksphinx-codeautolink automatically converts code examples in Sphinx…
- sphinx-gallerySphinx-Gallery is a Sphinx extension that automatically generates…
- sphobjinvInspect, search, and manipulate Sphinx objects.inv inventory files…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
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.
See also sphinx-hoverxref · sphinx-thebe · sphinx-click · sphinx-needs · sphinxcontrib-apidoc · sphinx-issues · sphinx-substitution-extensions · sphinx-copybutton · intersphinx-registry