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

  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:

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.

Project links

Data verified by PyPI on Jul 31, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for algolia from gravatar.com algolia Avatar for kai687 from gravatar.com kai687

Credits

Author: Algolia

GitHub Statistics

Data verified by PyPI on Jul 31, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

Requires

Python >=3.9

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_docsearch-0.3.1.tar.gz (141.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_docsearch-0.3.1-py3-none-any.whl (144.3 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_docsearch-0.3.1.tar.gz.

File metadata

  • Download URL: sphinx_docsearch-0.3.1.tar.gz
  • Upload date:
  • Size: 141.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sphinx_docsearch-0.3.1.tar.gz
Algorithm Hash digest
SHA256 b7c7f1a3ebab20964ca0fa611d16a563ade5fee69182193fc5afb755d06bddf6
MD5 8b235a6878779fae681cbadccb73cd75
BLAKE2b-256 96d99d98b370123d7da50e0297c971dc1f968c6dc360c21318e0fe9180a2f5d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_docsearch-0.3.1.tar.gz:

Publisher: ci.yml on algolia/sphinx-docsearch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_docsearch-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_docsearch-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3f982fdf9c1d78b9fc618a887c74a6a0e57db2130c74def4b99e5274b0bb274c
MD5 8bff63119d084330b359f54f2b5903cf
BLAKE2b-256 9be277848ba0f0a524e623f7c46413b7adb709a9953a22d0f6e5cd709fadc40e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_docsearch-0.3.1-py3-none-any.whl:

Publisher: ci.yml on algolia/sphinx-docsearch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page