sphinx-docsearch 0.0.4

A Sphinx extension for replacing the built-in search with Algolia DocSearch

Algolia DocSearch for Sphinx

This extension for the Sphinx documentation generator replaces Sphinx's built-in search with Algolia DocSearch.

Before you begin

Apply for DocSearch. You'll get an email with your Algolia credentials.

This extension supports Python versions 3.8, 3.9, 3.10, and 3.11 and Sphinx versions 5 and later.

Install

Install the sphinx-docsearch package:

pip install sphinx-docsearch

Configure

1. Add sphinx-docsearch to your Sphinx configuration:

   # conf.py
   extensions += ["sphinx_docsearch"]
   

2. Add your Algolia credentials to your Sphinx configuration:

   # conf.py
   docsearch_app_id = "<DOCSEARCH_APP_ID>"
   docsearch_api_key = "<DOCSEARCH_SEARCH_API_KEY>"
   docsearch_index_name = "<DOCSEARCH_INDEX_NAME>"
   

   See also: Configure DocSearch.

Customize

To change what the crawler should extract from your pages, see Record Extractor.

You can add custom templates, if your Sphinx HTML theme uses templates not provided by this extension.

You can customize the look of the DocSearch UI by adding your own CSS.