sphinx-thebe
Integrate interactive code blocks into your documentation with Thebe and Binder.
Decision gist · record as of 2026-08-14
Yes, if your documentation is Sphinx-based and you want to add interactivity without heavy infrastructure. The low install friction and zero security vulnerabilities are positives. However, the dormant maintenance status (last release Feb 2024, no recent commits) means you should verify compatibility with your Sphinx version and be prepared to fork or patch if issues arise. Confirm the license status before committing to production use.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx to be installed and configured; Thebe and Binder infrastructure must be available and properly configured in your documentation setup.
- Low friction install with a single runtime dependency on Sphinx.
- Maintenance is dormant—last release was 2024-02-07 and no commits since 2024-09-03—so expect no active bug fixes or feature updates, though the repository remains open and unarchived.
License · maintenance · safety
(unclear) — License status is unclear; the package metadata contains no SPDX identifier or raw license text. Verify the actual license before use in proprietary or restricted contexts.
last release 2024-02-07 (919 days) · last repo commit 2024-09-03 · 30 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 193,516 downloads/mo, #9,850 on PyPI
Alternatives
Verify before relying
pip install sphinx-thebe
Then add to your Sphinx conf.py:
extensions = [
"sphinx_thebe"
]- What license does sphinx-thebe actually use? The metadata is blank.
- Does Thebe/Binder integration require additional configuration beyond adding the extension?
- What are the runtime dependencies of Thebe itself, and do they introduce additional friction?
What it is and what it does
sphinx-thebe is a Sphinx extension that embeds interactive code execution into your documentation. It uses Thebe (a JavaScript library) and Binder (a cloud-hosted Jupyter service) to let readers run, modify, and experiment with code examples directly in their browser without leaving the documentation page. The extension handles the plumbing of connecting your code blocks to a live kernel.
You install it as a Python package, add it to your Sphinx configuration, and then annotate code blocks in your documentation to make them interactive. The extension depends only on Sphinx itself, making it straightforward to add to existing documentation builds. However, the project is dormant—no active maintenance since early 2024—so it may not keep pace with newer Sphinx versions or Thebe API changes.
Use it for
- Add runnable examples to technical documentation so readers can experiment with code without setting up a local environment.
- Create interactive tutorials where learners modify and execute code snippets directly in the browser.
- Demonstrate data science workflows in Jupyter-backed documentation, letting readers tweak parameters and see results live.
- Build educational materials where code blocks are executable, encouraging hands-on learning.
- Showcase library APIs with live examples that readers can test and adapt in real time.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if your documentation is Sphinx-based and you want to add interactivity without heavy infrastructure.
The low install friction and zero security vulnerabilities are positives. However, the dormant maintenance status (last release Feb 2024, no recent commits) means you should verify compatibility with your Sphinx version and be prepared to fork or patch if issues arise. Confirm the license status before committing to production use.
Install
sphinx-thebe on PyPI
Before you install
Low friction install with a single runtime dependency on Sphinx. Maintenance is dormant—last release was 2024-02-07 and no commits since 2024-09-03—so expect no active bug fixes or feature updates, though the repository remains open and unarchived.
Requires Sphinx to be installed and configured; Thebe and Binder infrastructure must be available and properly configured in your documentation setup.
License in practice
License status is unclear; the package metadata contains no SPDX identifier or raw license text. Verify the actual license before use in proprietary or restricted contexts.
Quickstart
pip install sphinx-thebe
Then add to your Sphinx conf.py:
extensions = [
"sphinx_thebe"
]Verify before relying
- What license does sphinx-thebe actually use? The metadata is blank.
- Does Thebe/Binder integration require additional configuration beyond adding the extension?
- What are the runtime dependencies of Thebe itself, and do they introduce additional friction?
Package facts
| License | Not declared unclear |
| Python support | Supports the current Python release >=3.8 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagesphinx |
| Maintenance | Dormant 919 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 193,516 / month, #9,850 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 :: Sphinx :: ExtensionIntended Audience :: DevelopersProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPyTopic :: Software Development :: Libraries :: Python Modules |
Evidence: sphinx_thebe-0.3.1-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 › “interactive code blocks sphinx”
- sphinx-thebeAdds interactive, executable code blocks to Sphinx documentation by…
- sphinx-togglepromptAdds a button to Python code blocks in Sphinx documentation that…
- jupyter-sphinxJupyter Sphinx Extensions runs code embedded in Sphinx documentation…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also jupyter-sphinx · sphinx-copybutton · sphinx-toggleprompt · sphinx-codeautolink · sphinx-substitution-extensions · readthedocs-sphinx-search · sphinx-gallery · sphinx-book-theme · sphinxcontrib-googleanalytics · sphinx-inline-tabs