sphinx-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.9 and later and Sphinx versions 7 and later.

For a list of supported themes, see HTML theme support

Install

Install the sphinx-docsearch package:

pip install sphinx-docsearch

Configure

• Add sphinx-docsearch to your Sphinx configuration:

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

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

  • Manage credentials
  • Configure DocSearch

Customize

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

If you're using a Sphinx theme that's not supported, you can add custom templates to add the DocSearch UI. You can further customize the look of the DocSearch UI by adding custom CSS. For more information, see Customize.