This repository was archived by the owner on Apr 8, 2025. It is now read-only.
Add filtering UI to search #130
Assignees
Comments
2 tasks
Merged
stsewd
added a commit
that referenced
this issue
Mar 27, 2023
- Added 2 new options: rtd_sphinx_search_default_filter and rtd_sphinx_search_filters. - The options are passed as a JSON object to be read by our JS code. - The default filter defaults to the current project and version (extracted from the RTD env vars) - Filters are implemented as check boxes, we only support one filter at a time (when a filter is selected, we uncheck all others) How to test locally: - Run your local version of RTD - To allow cross site requests, add `|/api/v3/search` at https://github.com/readthedocs/readthedocs.org/blob/b574f4b0dad34ccba8595cee72246d3473f8a2e5/readthedocs/settings/base.py#L769-L781 - Change the `rtd_dummy_data.json` file - `'proxied_api_host': 'http://devthedocs.org'` - Set the project and version to a project that you have locally - Change the value of `rtd_sphinx_search_default_filter = "project:superproject/latest"` to the slug of a project you have locally - Build the docs: ``` cd docs make clean html ``` - Open the _build/index.html file. ### showcase [showcase.webm](https://user-images.githubusercontent.com/4975310/225148123-7811d477-3a91-4eea-b9fb-b8cb1cbf0d6a.webm) Closes #129 Closes #130 Closes #131
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Our RTD search has a lot of nice filters on it. We should expose this with a a fancier UI element for filters in the extension, along with having them in the query string.
I'm imagining something similar to this:
Having the checkboxes that at least by default includes subprojects.
The text was updated successfully, but these errors were encountered: