Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update adding of google analytics key for docs #24495

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 18, 2022

Conversation

ksunden
Copy link
Member

@ksunden ksunden commented Nov 18, 2022

PR Summary

Pydata-sphinx-theme actually deprecated the top level config key
"google_analytics_id" a few releases ago, though with a standard
DeprecationWarning (which is silenced by default) so we did not catch
it.

The deprecation was expired for 0.12.0, which resulted in a warning (and
thus CircleCI reporting failure).

Further, this option is only added in "release mode" builds, so standard PRs do not pick it up.

For more info see the pydata-sphinx-theme docs.

Essentially, it is simply adding a layer of nesting for the analytics
tokens.

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

Pydata-sphinx-theme actually deprecated the top level config key
"google_analytics_id" a few releases ago, though with a standard
DeprecationWarning (which is silenced by default) so we did not catch
it.

The deprecation was expired for 0.12.0, which resulted in a warning (and
thus CircleCI reporting failure).

For more info see [the pydata-sphinx-theme docs](https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/analytics.html).

Essentially, it is simply adding a layer of nesting for the analytics
tokens.
@QuLogic QuLogic added this to the v3.6.3 milestone Nov 18, 2022
@QuLogic QuLogic merged commit fc8e041 into matplotlib:main Nov 18, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Nov 18, 2022
oscargus added a commit that referenced this pull request Nov 18, 2022
…495-on-v3.6.x

Backport PR #24495 on branch v3.6.x (Update adding of google analytics key for docs)
@ksunden ksunden deleted the docs_analytics branch December 27, 2022 18:50
@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.

2 participants