search

algolia / sphinx-docsearch

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

Max results are 5: Pagination? View all results? Extend # results? #44

Closed dylanh724 closed 1 week ago

dylanh724 commented 1 week ago

Hey folks:

I've implemented the search and get max 5 results.

I noticed no pagination and no "view all results" link; how can I add these using sphinx-docsearch?

kai687 commented 1 week ago

Pagination and 'view all results' is not supported with the DocSearch UI and will therefore not be available here either.

IMO anything but a simple drop-down menu is difficult to make work as a search box for every page. Most implementations are either cluttered or have other shortcomings (quite often accessibility). I think, if you want a more complex experience, it's much better to have a dedicated search results page with pagination and filtering options (perhaps). Algolia has the open source InstantSearch.js library, which you can use to build such a search results page relatively easily.

I'll close this issue, because there isn't much I can do in this extension until DocSearch supports it. But I'll work on the other issues you reported :)