📰 This Sphinx extension is deprecated

[humitos]

Hi all 👋🏼

We've deprecated this extension in favor of the new Read the Docs Addons, that includes a search addon. These addons are going to be enabled by default to all projects building on Read the Docs starting on October 7th, 2024. Read the full announcement at Read the Docs Addons enabled by default blog post.

The new search addon uses the exact same API backend, has a fresh UI¹ and more features (eg. filters and recent searches). Besides, it supports any documentation tool, not only Sphinx, allowing you to perform a search across all the projects at once.

If you are looking for a "Search as you type" Sphinx extension, we recommend you to not install this extension and enable Read the Docs Addons in your project instead.

If you are already using this extension, you can keep using it, but keep it mind the repository is going to be archived and it won't receive further features or fixes. However, we recommend you to migrate to Read the Docs Addons before October 7th to avoid any potential incompatibility.

Footnotes

1. we plan to continue making improvements here. ↩