{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"A Sphinx extension that adds real-time search-as-you-type functionality to documentation hosted on Read the Docs.","skillfed_tags":["sphinx-extension","archived"],"use_cases":["Add live search to Sphinx-based documentation already hosted on Read the Docs without additional backend infrastructure.","Improve documentation discoverability for users by providing instant search results as they type queries.","Reduce friction in finding relevant documentation sections for projects using Read the Docs as their primary hosting platform."],"what_it_does":"readthedocs-sphinx-search is a Sphinx extension that integrates live search functionality into documentation sites hosted on Read the Docs. It enables users to search documentation content as they type, providing immediate feedback without requiring a full page reload or separate search submission.\n\nThe extension is designed specifically for Read the Docs hosting and requires only Sphinx as a dependency. It is configured by adding a single line to your Sphinx conf.py file. However, the project is now archived and abandoned, with the last commit in July 2024 and no active maintenance\u2014it remains in Beta status and should be treated as a stable but unmaintained tool.","worth_installing":"Yes, if you are hosting Sphinx documentation on Read the Docs and want search-as-you-type without additional complexity. No, if you need active maintenance or expect to upgrade Sphinx frequently\u2014the project is archived and unmaintained. Verify compatibility with your current Sphinx version before adopting."},"id":"readthedocs-sphinx-search","links":{"html":"https://skillfed.io/packages/readthedocs-sphinx-search","md":"https://skillfed.io/packages/readthedocs-sphinx-search.md","pypi":"https://pypi.org/project/readthedocs-sphinx-search/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2024-01-15","license_spdx":null,"license_treatment":"permissive","name":"readthedocs-sphinx-search","python_support":"supports_current","summary":"Sphinx extension to enable search as you type for docs hosted on Read the Docs."},"popularity":{"monthly_downloads":138200,"position":11340,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.3.2"}
