DOC: Enable Opensearch by StefRe · Pull Request #24957 · matplotlib/matplotlib · GitHub
Skip to content

DOC: Enable Opensearch - #24957

Merged
jklymak merged 1 commit into
matplotlib:mainfrom
StefRe:patch-1
Jan 12, 2023
Merged

DOC: Enable Opensearch#24957
jklymak merged 1 commit into
matplotlib:mainfrom
StefRe:patch-1

Conversation

@StefRe

@StefRe StefRe commented Jan 12, 2023

Copy link
Copy Markdown
Contributor

PR Summary

Fix html_use_opensearch in conf.py: the current value of 'False' is misinterpreted as the url False. 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

  • [N/A] Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build 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 in doc/users/next_whats_new/
  • [N/A] API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • [N/A] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@jklymak

jklymak commented Jan 12, 2023

Copy link
Copy Markdown
Member

@StefRe

StefRe commented Jan 12, 2023

Copy link
Copy Markdown
Contributor Author

@tacaswell tacaswell added this to the v3.7.0 milestone Jan 12, 2023

@tacaswell tacaswell left a comment

Copy link
Copy Markdown
Member

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.

@jklymak
jklymak merged commit cf1b601 into matplotlib:main 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)
@StefRe
StefRe deleted the patch-1 branch January 12, 2023 22:48
@ksunden ksunden mentioned this pull request Feb 20, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Error Adding OpenSearch Plugin

4 participants