Support search redirects to PennyLane.ai #47
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mandrenkov
added
the
do not merge yet
Mandrenkov
added a commit
to PennyLaneAI/pennylane-sphinx-theme
that referenced
this pull request
Oct 16, 2024
3 tasks
Co-authored-by: Andrew Gardhouse <[email protected]>
ashishks0522
added a commit
to PennyLaneAI/pennylane-sphinx-theme
that referenced
this pull request
Dec 16, 2024
**Context:** Search in Sphinx is, both functionally and aesthetically, lacking. This PR upgrades the version of the [Xanadu Sphinx Theme](https://github.com/XanaduAI/xanadu-sphinx-theme) to `0.6.0` which includes a theme option for redirecting users from `search.html` to https://pennylane.ai/search. **Description of the Change:** 1. Integrated XanaduAI/xanadu-sphinx-theme#47. **Benefits:** 1. PennyLane Docs users have easier access to a better search experience. **Possible Drawbacks:** _None._ **Related GitHub Issues:** _None._ --- **Verification:** See https://xanaduai-pennylane--67.com.readthedocs.build/projects/sphinx-theme/en/67/. **Merge Checklist:** * [X] XanaduAI/xanadu-sphinx-theme#47 is merged. * [X] References to XST GitHub repository branches and replaced with semantic versions. * [X] PennyLane Docs are surfaced in PennyLane.ai search results. --------- Co-authored-by: ashishks0522 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context:
Search in Sphinx is, both functionally and aesthetically, lacking. This PR introduces a theme option (for the PennyLane Sphinx Theme) to redirect users from
search.htmlto https://pennylane.ai/search (with the right query parameters).It's worth noting that PennyLane Docs are not surfaced yet in PennyLane.ai search results but this will change soon.
Description of the Change:
search_on_pennylane_ai, which redirects users fromsearch.html(i.e., after submitting a query using the search box in the LHS ToC) to https://pennylane.ai/search with the following query parameters:contentType: Set toDOC.q: Set to the query in the search box.version: Set tostable, unless/latest/is part of the current URL, in which caselatestis used instead.Benefits:
Possible Drawbacks:
None.
Related GitHub Issues:
None.
Verification:
See https://xanaduai-pennylane--67.com.readthedocs.build/projects/sphinx-theme/en/67/.
Merge Checklist: