Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

DOC: Enable Opensearch#24957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
jklymak merged 1 commit intomatplotlib:mainfromStefRe:patch-1
Jan 12, 2023
Merged

DOC: Enable Opensearch#24957

jklymak merged 1 commit intomatplotlib:mainfromStefRe:patch-1
Jan 12, 2023

Conversation

StefRe
Copy link
Contributor

PR Summary

Fixhtml_use_opensearch in 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 alsohttps://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_use_opensearch.

Closesmatplotlib/mpl-sphinx-theme#56.

PR Checklist

Documentation and Tests

  • [N/A] Has pytest style unit tests (andpytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
  • [N/A] New plotting related features are documented with examples.

Release Notes

  • [N/A] New features are marked with a.. versionadded:: directive in the docstring and documented indoc/users/next_whats_new/
  • [N/A] API changes are marked with a.. versionchanged:: directive in the docstring and documented indoc/api/next_api_changes/
  • [N/A] Release notes conform with instructions innext_whats_new/README.rst ornext_api_changes/README.rst

@jklymak
Copy link
Member

Can we test that this works without deploying the docs or do we need to deploy?

@StefRe
Copy link
ContributorAuthor

Can we test that this works without deploying the docs or do we need to deploy?

Not directly, but Sphinx created a correctOpenSearch xml file, so I guess it should work:

<?xml version="1.0" encoding="UTF-8"?><OpenSearchDescriptionxmlns="http://a9.com/-/spec/opensearch/1.1/">  <ShortName>Matplotlib</ShortName>  <Description>Search Matplotlib 3.7.0.dev1342+g0896385db6 documentation</Description>  <InputEncoding>utf-8</InputEncoding>  <Urltype="text/html"method="get"template="https://matplotlib.org/stable/search.html?q={searchTerms}"/>  <LongName>Matplotlib 3.7.0.dev1342+g0896385db6 documentation</LongName>  <Imageheight="16"width="16"type="image/x-icon">https://matplotlib.org/stable/_static/favicon.ico</Image>  </OpenSearchDescription>

(in the current, not working version, the template istemplate="False/search.html?q={searchTerms}")

@tacaswelltacaswell added this to thev3.7.0 milestoneJan 12, 2023
Copy link
Member

@tacaswelltacaswell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I see no harm in enabling this.

@jklymakjklymak merged commitcf1b601 intomatplotlib:mainJan 12, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestJan 12, 2023
oscargus added a commit that referenced this pull requestJan 12, 2023
…957-on-v3.7.xBackport PR#24957 on branch v3.7.x (DOC: Enable Opensearch)
@StefReStefRe deleted the patch-1 branchJanuary 12, 2023 22:48
@ksundenksunden mentioned this pull requestFeb 20, 2023
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@tacaswelltacaswelltacaswell approved these changes

@jklymakjklymakjklymak approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.7.0
Development

Successfully merging this pull request may close these issues.

Error Adding OpenSearch Plugin
4 participants
@StefRe@jklymak@tacaswell@QuLogic
[8]ページ先頭
©2009-2025 Movatter.jp