{"categories":[{"label":"Python Modules","url":"https://skillfed.io/packages/category/software-development-libraries-python-modules/16"}],"enrichment":{"capability":"Adds interactive, executable code blocks to Sphinx documentation by integrating Thebe and Binder, allowing readers to run and modify code examples directly in the browser.","skillfed_tags":["interactive-docs","jupyter-integration","sphinx-extension"],"use_cases":["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."],"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.\n\nYou 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\u2014no active maintenance since early 2024\u2014so it may not keep pace with newer Sphinx versions or Thebe API changes.","worth_installing":"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."},"id":"sphinx-thebe","links":{"html":"https://skillfed.io/packages/sphinx-thebe","md":"https://skillfed.io/packages/sphinx-thebe.md","pypi":"https://pypi.org/project/sphinx-thebe/"},"maintenance":{"status":"dormant"},"meta":{"latest_release":"2024-02-07","license_spdx":null,"license_treatment":"unclear","name":"sphinx-thebe","python_support":"supports_current","summary":"Integrate interactive code blocks into your documentation with Thebe and Binder."},"popularity":{"monthly_downloads":193516,"position":9850,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.3.1"}
