Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
50 lines (35 sloc) 1.46 KB

readthedocs-sphinx-search

Documentation Status Repository license Build Status

readthedocs-sphinx-search is a Sphinx extension which adds a full-page search UI with search as you type feature to your documentation. This extension is compatible with all the documentations hosted on Read the Docs.

In-Doc Search UI

Using the existing search backend of Read the Docs, this extension is designed to greatly improve the search experience of the reader. To experience it first hand, try searching in this documentation or visit here: https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing

.. toctree::
   :maxdepth: 2
   :caption: Table of Contents

   installation
   features
   configuration
   custom-design
   development
   testing
   js-api-reference
   get-involved


You can’t perform that action at this time.