Update adding of google analytics key for docs #24495
Merged
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
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
pytest
passes)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.rst
ornext_api_changes/README.rst