readthedocs-sphinx-search

Sphinx extension to enable search as you type within a full-page search UI for docs hosted on Read the Docs. Try it at https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing.

Installation

pip install readthedocs-sphinx-search

Configuration

Add this extension in your conf.py file as:

extensions = [
 # ... other extensions here
 'sphinx_search.extension',
]

Table of Contents

• Installation
• Features
  • Search As You Type
  • Minimal UI
  • Interaction With Keyboard
  • Link To The Search UI
  • Browser Support
• Configuration
• Customization
  • Custom search input
  • Custom styles
• Development
  • Releasing
• Testing
  • Continuous Integration
• JavaScript API Reference
• Get Involved
• Changelog