Investigate Algolia as alternative Search Solution

[michaelweinold]

Apparently we have more options related to the underlying search engine of the readthedocs.org hosted documentation page than I had been aware of. For instance, Algolia has a Sphinx extension: algolia/sphinx-docsearch.

Related:

• https://github.com/pydata/pydata-sphinx-theme/issues/795
• https://github.com/readthedocs/sphinx_rtd_theme/issues/761

Some other major documentation sites switching to Algolia:

• https://github.com/scikit-learn/scikit-learn/pull/29666

[michaelweinold]

No charges would be incurred - but I would still appreciate it if you could let me know if you approve me "joining the program", @cmutel.

[cmutel]

OK with me, thanks for pushing forward.

[michaelweinold]

Hi there 👋

Thanks for your interest and trust in Algolia DocSearch. We've received your request for https://docs.brightway.dev/ and will get back to you soon. This is an automated message, no need to respond until we process your application (typically 1-2 business days).

DocSearch is built in two parts:

• A crawler which we run in our own infrastructure every week (configurable). It follows every link in your website and extracts content from every page it traverses. It then pushes this content to an Algolia index. (Read more: https://www.algolia.com/doc/tools/crawler/getting-started/overview/ )
• A JavaScript snippet to be inserted in your website that will bind this Algolia index to your search input and display its results in a modal UI. (Read more: https://github.com/algolia/docsearch )

If you want to find more details on how DocSearch works, take a look at the docs: https://docsearch.algolia.com/

Meanwhile, let us know if you have any other questions.

Have a great day, The DocSearch team.

DocSearch is powered by Algolia. See more at https://www.algolia.com/