readthedocs-sphinx-ext
Sphinx extension for Read the Docs overrides
Decision gist · record as of 2026-08-14
No, not for new projects. The package is abandoned and will not receive maintenance or security updates. While it carries no current vulnerabilities and has low install friction, its lack of active development makes it unsuitable for new documentation setups. Consider it only if you are maintaining an existing project that already uses it and requires no updates.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx to be installed and configured; intended for use in Sphinx documentation projects.
- Low install friction with three common runtime dependencies (requests, Jinja2, packaging).
- However, the package is archived and abandoned as of 2023-12-19, with no maintenance activity since then, so it will not receive updates or security patches.
License · maintenance · safety
MIT (permissive) — MIT license is permissive, allowing use in most projects with minimal restrictions.
last release 2023-12-19 (969 days) · last repo commit 2023-12-19 · 18 stars · archived
0 known vulnerabilities (OSV.dev, 2026-08-14) · 112,642 downloads/mo, #12,364 on PyPI
Alternatives
Verify before relying
pip install readthedocs-sphinx-ext
# In conf.py:
extensions = ['readthedocs_sphinx_ext.readthedocs']- Whether the extension remains compatible with current Sphinx versions despite being unmaintained.
- Whether Read the Docs still actively uses or recommends this extension in its current documentation builds.
- What specific template-meta functionality is available and how it differs from native Sphinx features.
What it is and what it does
This package provides Sphinx extensions designed to make documentation builds work better with Read the Docs infrastructure. It ships with an extension for building docs in the Read the Docs style and a template-meta extension that lets you specify per-page template overrides. The package depends on requests, Jinja2, and packaging to handle HTTP requests, template rendering, and version parsing.
The package is no longer maintained—the repository was archived and has not received updates since 2023-12-19. While it carries no known security vulnerabilities and uses a permissive MIT license, its abandonment means it will not adapt to changes in Sphinx, Read the Docs, or its dependencies. It may still work for existing projects, but should be considered a legacy tool rather than an active choice for new documentation setups.
Use it for
- Integrating Sphinx documentation builds with Read the Docs hosting to apply platform-specific styling and features.
- Enabling per-page template customization in Sphinx docs via the template-meta extension.
- Maintaining existing documentation projects that already depend on this extension and do not require updates.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
No, not for new projects.
The package is abandoned and will not receive maintenance or security updates. While it carries no current vulnerabilities and has low install friction, its lack of active development makes it unsuitable for new documentation setups. Consider it only if you are maintaining an existing project that already uses it and requires no updates.
Install
readthedocs-sphinx-ext on PyPI
Before you install
Low install friction with three common runtime dependencies (requests, Jinja2, packaging). However, the package is archived and abandoned as of 2023-12-19, with no maintenance activity since then, so it will not receive updates or security patches.
Requires Sphinx to be installed and configured; intended for use in Sphinx documentation projects.
License in practice
MIT license is permissive, allowing use in most projects with minimal restrictions.
Quickstart
pip install readthedocs-sphinx-ext
# In conf.py:
extensions = ['readthedocs_sphinx_ext.readthedocs']Verify before relying
- Whether the extension remains compatible with current Sphinx versions despite being unmaintained.
- Whether Read the Docs still actively uses or recommends this extension in its current documentation builds.
- What specific template-meta functionality is available and how it differs from native Sphinx features.
Package facts
| License | MIT permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesrequestsJinja2packaging |
| Maintenance | Abandoned 969 days since the last release |
| Last repo commit | repository archived |
| First released | |
| Downloads | 112,642 / month, #12,364 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
Evidence: readthedocs_sphinx_ext-2.2.5-py2.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 read the docs integration”
- readthedocs-sphinx-extProvides Sphinx extensions that integrate documentation builds with…
- readthedocs-sphinx-searchA Sphinx extension that adds real-time search-as-you-type…
- sphinx-rtd-themeA Sphinx theme that renders documentation with a responsive,…
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 readthedocs-sphinx-search · sphinx-multiversion · sphinxemoji · sphinx-data-viewer · linuxdoc · sphinx-jinja · sphinx-click · sphinx-substitution-extensions · breathe · ghp-import