algolia / sphinx-docsearch

Add Algolia DocSearch to your Sphinx documentation project
https://sphinx-docsearch.readthedocs.io/
MIT License
12 stars 1 forks source link

What's the difference with `sphinxawesome_theme.docsearch`? #15

Closed astrojuanlu closed 10 months ago

astrojuanlu commented 10 months ago

As per title 😊 We noticed that Awesome Sphinx Theme (amazing theme by the way) has its own DocSearch extension:

https://sphinxawesome.xyz/how-to/configure/#bundled-extensions

https://github.com/kai687/sphinxawesome-theme/blob/dfc68e7ad90eed836fc7b38cb5d52674e104b6df/docs/conf.py#L31

Are there any practical differences?

Context: we want to adopt this (or the other) extension for Kedro https://github.com/kedro-org/kedro/issues/2932

kai687 commented 10 months ago

Thanks for your kind words!

The 'bundled' extension that's part of the Awesome Theme cannot be used outside of the Awesome Theme. So, if you want to use the Awesome Sphinx Theme, you don't have to use the sphinx-docsearch extension.

If you want to use another theme, use the sphinx-docsearch extension.

When I wrote the Awesome Sphinx Theme, I baked DocSearch support right into the theme. As I'm working on version 5 of the theme, and having spun-off the sphinx-docsearch extension, I plan to eventually replace the theme's internal DocSearch extension with the sphinx-docsearch extension.

Let me know if that makes sense or not.

astrojuanlu commented 10 months ago

Perfect, thanks for the clarification! Closing this issue

stichbury commented 10 months ago

Thanks @kai687 🙏