Add ability to add extra cross-project search projects on an opt-in basis
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
The issue identifies no files, tests, or entry points. Start by locating the existing cross-project search and configuration handling in the Sphinx theme, then determine how opt-in groups and their enabled state are represented; done means the proposed configuration supports optional project groups and the search behavior matches the configured state.
Written by the indexing model from the issue text.
Description
Describe the feature
For SunPy it would be a nice addition to opt-in to also searching the astropy documentation.
Proposed solution
I'm thinking that it would be good to have something like the default RTD option for subprojects but for "include ":
I think it would be nice to have this configurable where you can configure one or more groups which the user can then enable, i.e.:
rtd_search_extras = {
"astropy": {"default_enabled": False, "projects": [{"slug": "astropy", "link": "https://docs.astropy.org"}]}
}
- 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
-
Mend: dependency security vulnerability untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
opensearch-project/security-dashboards-plugin#2543 ·
Maintainers usually reply within 1 day
-
[quality] refresh-radar-reports.yml runs on ubuntu-latest while every other job pins ubuntu-24.04Openagent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
godotengine/godot-website#1432 ·
-
Add: Mooz RetroOpenchannels:add check:passed
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day