Documentation: Indicator Search - Add YAML id to search functionality #1525
Labels
docs
Improvements to documenation
enhancement
New feature or request
indicators
Climate indices and indicators
Comments
SarahG-579462
added
docs
5 tasks
huard
added a commit
that referenced
this issue
Nov 29, 2023
<!--Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
- This PR fixes #1525
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] (If applicable) Documentation has been added / updated (for bug
fixes / features)
- [x] CHANGES.rst has been updated (with summary of main changes)
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added
### What kind of change does this PR introduce?
* In the RtD, indicator search now searches through the indicator IDs.
### Does this PR introduce a breaking change?
### Other information:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Generic Issue
Description
YAML id is in the info box, but isn't searchable. This is annoying when you know the yaml id but not the exact indicator name, and want to know specifics about the calculation, for example.
What I Did
Go to https://xclim.readthedocs.io/en/stable/indicators.html, and try to search for "icclim.bedd", for example.
What I Received
No results were received.
Code of Conduct
The text was updated successfully, but these errors were encountered: