Skip to content
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

DOC: Add an option to disable Google Analytics. #18557

Merged
merged 2 commits into from Sep 25, 2020

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Sep 24, 2020

PR Summary

Fixes #5823.

PR Checklist

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • [n/a] New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and pydocstyle<4 and run flake8 --docstring-convention=all).
  • [n/a] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@QuLogic QuLogic added this to the v3.4.0 milestone Sep 24, 2020
@dstansby
Copy link
Member

Is there a way to more intelligently only add the google analytics code for pages served on matplotlib.org? If not this seems like a good solution.

@timhoffm
Copy link
Member

Is there a way to more intelligently only add the google analytics code for pages served on matplotlib.org? If not this seems like a good solution.

Can't we configure the build to not include analytics by default, and only optionally enable it via a parameter sphinx-build -D or sphinx-build -A.
Then, only set that parameter for the release doc build.

@QuLogic
Copy link
Member Author

QuLogic commented Sep 24, 2020

Ah, I didn't see that in Sphinx; that seems a good way to do it.

Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Waiting for another review since @tacaswell's approval was for another solution.

@tacaswell tacaswell merged commit bf3827a into matplotlib:master Sep 25, 2020
@QuLogic QuLogic deleted the no-ga branch September 25, 2020 03:38
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.

pleas dont include the Google Analytics tracking in the off-line doc
4 participants