Registry / devops / readthedocs-sphinx-ext

readthedocs-sphinx-ext

JSON →
library2.2.5pypypiunverified

Sphinx extension that provides custom directives and configurations used by Read the Docs builds, including the `readthedocs` and `readthedocs-sphinxsearch` builders, custom roles, and overrides for analytics, PDF, and EPub generation. Version 2.2.5 is the latest stable release, with a maintenance cadence aligned with Read the Docs platform updates.

pip install readthedocs-sphinx-ext
INSTALL
IMPORT
SIG · READTHEDOCS-SPHINX
R
readthedocs-sphinx-ext
devopspythonv2.2.5
Install
2.6s avg
Import
Disk
21MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v2.2.5 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 22.9MB
glibc
py 3.103.95 runs
installs and imports cleanly · install 2.6s · import 0.000s · 23MB
21MB installed
● package 21MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

ReadTheDocsBuilder
from readthedocs_ext import ReadTheDocsBuilder
from readthedocs_ext import ReadTheDocsBuilder

Add the extension to your Sphinx conf.py to enable Read the Docs specific builders and overrides.

# Add to conf.py: extensions = ['readthedocs_ext.readthedocs']
Debug
Known issues
breakingThe extension is automatically injected by Read the Docs when building. Manually adding it can cause conflicts if versions mismatch.
fix
Only add this extension manually if building locally and you need the exact same environment as on Read the Docs.
affects: all
gotchaDo NOT add both 'readthedocs_ext.readthedocs' and 'sphinx_rtd_theme' in extensions. The former already includes theme overrides.
fix
Use only 'readthedocs_ext.readthedocs' in extensions and ensure readthedocs-sphinx-ext is installed.
affects: all
deprecatedThe 'readthedocs' builder (classic) is deprecated in favor of 'readthedocs-sphinxsearch'. Check the docs for migration.
fix
Set builder = 'readthedocs-sphinxsearch' in conf.py or use the Read the Docs admin panel.
affects: >=2.2.0
Upgrade
Version history
2.2.5latest on PyPI · released Dec 19, 2023
Audit
Dependencies

No dependency data recorded yet.

Agent activity
11 hits · last 30 days
node
10
Resources
readthedocs-sphinx-ext — pip install readthedocs-sphinx-ext · libregistry