readthedocs-sphinx-search

What it is and 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.

The 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—it remains in Beta status and should be treated as a stable but unmaintained tool.

Use it for:

• 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.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx extension that adds real-time search-as-you-type functionality to documentation hosted on Read the Docs.

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—the project is archived and unmaintained. Verify compatibility with your current Sphinx version before adopting.

Install

readthedocs-sphinx-search on PyPI

pip install readthedocs-sphinx-search

uv add readthedocs-sphinx-search

poetry add readthedocs-sphinx-search

Installing readthedocs-sphinx-search

Before you install

Low friction installation with no runtime dependencies. However, the project is archived and abandoned as of mid-2024, with no active maintenance—use only if the current feature set meets your needs.

License in practice

MIT license permits free use, modification, and distribution with minimal restrictions, making it safe to integrate into most projects.

Quickstart

pip install readthedocs-sphinx-search

Then in your Sphinx conf.py:
extensions = [
    'sphinx_search.extension',
]

Requires Sphinx to be installed and configured; intended for docs hosted on Read the Docs.

Verify before relying

• Whether the search-as-you-type feature remains fully functional with current Read the Docs infrastructure and modern Sphinx versions.
• Compatibility with recent Sphinx releases and whether any breaking changes have occurred since the last release in January 2024.

Package facts

Evidence: readthedocs_sphinx_search-0.3.2-py3-none-any.whl

Keywords: sphinx, search, readthedocs

Tags

More Sphinx packages