Remove the fallback to parsing the HTML when `rtd_search_projects` is not set
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
Read src/sunpy_sphinx_theme/theme/sunpy/static/js/rtd_enhanced_search.js around lines 80-92, then inspect the Python theme configuration that now provides rtd_search_projects. Confirm the intended behavior when that setting is absent; done means the unnecessary HTML-parsing fallback is removed and the remaining search behavior matches the configuration.
Written by the indexing model from the issue text.
Description
Provide a general description of the issue or problem.
This section of the code:
Isn't really needed now we have the Python theme configuration.
@slowe How would you recommend we remove this? I think we would need to just fallback to the original sphinx search? I can make the Python configuration raise an error, so it should be unlikely to hit this.
- Dominant language
- JavaScript
- Stars
- 7
- Forks
- 17
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from sunpy/sunpy-sphinx-theme
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
sunpy/sunpy-sphinx-theme#337 ·
-
rtd_enhanced_search.js hits v3 API without version, RTD returns stable results on non-stable buildsOpen
Difficulty 3/5 1-2 days Newbie friendliness 72/100
sunpy/sunpy-sphinx-theme#327 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
sunpy/sunpy-sphinx-theme#321 · 1 comment ·
-
Enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
sunpy/sunpy-sphinx-theme#308 · 2 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
sunpy/sunpy-sphinx-theme#300 ·
All issues in sunpy/sunpy-sphinx-theme
Similar issues
-
refactor
Difficulty 2/5 Half a day Newbie friendliness 84/100
Maintainers usually reply within 5 days
-
translation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ciderapp/translations#87 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Maintainers usually reply within 1 day
-
component: split-view platform: windows
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
zen-browser/desktop#15616 · 1 reaction ·
Maintainers usually reply within 1 day