DOC: Enable Opensearch #24957
Merged
DOC: Enable Opensearch #24957
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
|
Can we test that this works without deploying the docs or do we need to deploy? |
Not directly, but Sphinx created a correct OpenSearch xml file, so I guess it should work: <?xml version="1.0" encoding="UTF-8"?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
<ShortName>Matplotlib</ShortName>
<Description>Search Matplotlib 3.7.0.dev1342+g0896385db6 documentation</Description>
<InputEncoding>utf-8</InputEncoding>
<Url type="text/html" method="get"
template="https://matplotlib.org/stable/search.html?q={searchTerms}"/>
<LongName>Matplotlib 3.7.0.dev1342+g0896385db6 documentation</LongName>
<Image height="16" width="16" type="image/x-icon">https://matplotlib.org/stable/_static/favicon.ico</Image>
</OpenSearchDescription>(in the current, not working version, the template is |
tacaswell
approved these changes
Jan 12, 2023
jklymak
approved these changes
Jan 12, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jan 12, 2023
oscargus
added a commit
that referenced
this pull request
Jan 12, 2023
…957-on-v3.7.x Backport PR #24957 on branch v3.7.x (DOC: Enable Opensearch)
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
Fix
html_use_opensearchin conf.py: the current value of'False'is misinterpreted as the urlFalse. If no OpenSearch description file should be created the value must be empty (default), but I think OpenSearch is a very handy feature, so I'd like to enable it.See also https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_use_opensearch.
Closes matplotlib/mpl-sphinx-theme#56.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst