DOC: Reactivate search for codex #11169
Merged
Conversation
This file contains hidden or 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
jklymak
reviewed
May 4, 2018
| @@ -986,7 +986,7 @@ div.sphx-glr-download a { | |||
| background-image: none !important; | |||
| } | |||
|
|
|||
| p.sphx-glr-signature a.reference.external { | |||
There was a problem hiding this comment.
did you mean to drop the css for a.reference.external?
There was a problem hiding this comment.
Yes, because I want to hide not only the <a> tag but the outer <p> tag.
It can of course be discussed whether the search keywords should still be shown on the page. In my opinion that just distracts and is not really useful.
|
This can be backported to 2.2.2-doc as it is only touching thing in the doc folder. |
|
Thanks @ImportanceOfBeingErnest ! |
jklymak
added a commit
that referenced
this pull request
May 6, 2018
Backport PR #11169 on branch v2.2.2-doc
QuLogic
reviewed
May 10, 2018
| @@ -17,6 +17,9 @@ | |||
| import matplotlib | |||
| import sphinx | |||
|
|
|||
| # This is only necessary to monkey patch the signature later on. | |||
| from sphinx_gallery import gen_rst | |||
There was a problem hiding this comment.
This should be moved below the _check_deps call below to prevent ImportErrors when sphinx-gallery is not yet installed.
There was a problem hiding this comment.
I made a new PR #11221 for that. Thanks for taking a close look.
6 tasks
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.
PR Summary
Fixes #11151 (DOC: In search for the matplotlib codex Documentation)
That is, previously the search could be limited to code examples by typing "codex" in the search field. This got lost in the transfer to sphinx-gallery.
This PR fixes this by monkey patching the sphinx-gallery signature and putting adding the search terms to it. The signature stays invisible so the search terms are not shown in the actual output.