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-docsearchto 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:
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.
Release files for sphinx-docsearch 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_docsearch-0.3.1.tar.gz | 141.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_docsearch-0.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 285.9 kB
Release files / sphinx_docsearch-0.3.1.tar.gz
| Download URL | sphinx_docsearch-0.3.1.tar.gz |
|---|---|
| Size | 141.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b7c7f1a3ebab20964ca0fa611d16a563ade5fee69182193fc5afb755d06bddf6
|
|
BLAKE2b-256 checksum How to use checksums |
96d99d98b370123d7da50e0297c971dc1f968c6dc360c21318e0fe9180a2f5d6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 31, 2026.
Transparency logRelease files / sphinx_docsearch-0.3.1-py3-none-any.whl
| Download URL | sphinx_docsearch-0.3.1-py3-none-any.whl |
|---|---|
| Size | 144.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3f982fdf9c1d78b9fc618a887c74a6a0e57db2130c74def4b99e5274b0bb274c
|
|
BLAKE2b-256 checksum How to use checksums |
9be277848ba0f0a524e623f7c46413b7adb709a9953a22d0f6e5cd709fadc40e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 31, 2026.
Transparency log
