{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Adds interactive tooltips to Sphinx documentation using the Tippy.js library, allowing you to display rich, contextual help text on hover or click.","skillfed_tags":["sphinx-extension","documentation-ui","interactive-docs"],"use_cases":["Add hover tooltips to API documentation explaining parameter types and constraints","Annotate technical terms in guides with definitions that appear on click","Provide code examples or warnings as tooltips without interrupting reading flow","Create interactive glossaries where terms link to expandable tooltip definitions"],"what_it_does":"sphinx-tippy is a Sphinx extension that integrates Tippy.js into your documentation build to render interactive tooltips. It lets you annotate documentation with rich, styled tips that appear on user interaction, enhancing readability and providing contextual help without cluttering the main text.\n\nThe package depends on sphinx as its core framework, beautifulsoup4 for HTML parsing, jinja2 for templating, and requests for HTTP operations. It's designed for developers building Sphinx-based documentation who want to add a layer of interactivity for explaining terms, showing examples, or providing supplementary information inline.","worth_installing":"Yes, if you use Sphinx and want to add interactive tooltips with minimal setup. The package is actively maintained, has low install friction, carries a permissive MIT license, and has no known vulnerabilities. The Beta status is typical for documentation extensions and should not be a blocker for production use."},"id":"sphinx-tippy","links":{"html":"https://skillfed.io/packages/sphinx-tippy","md":"https://skillfed.io/packages/sphinx-tippy.md","pypi":"https://pypi.org/project/sphinx-tippy/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2024-04-23","license_spdx":null,"license_treatment":"permissive","name":"sphinx_tippy","python_support":"supports_current","summary":"Get rich tool tips in your sphinx documentation!"},"popularity":{"monthly_downloads":97628,"position":13139,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.4.3"}
