MkDocs projects use RTD's analytics privacy improvements #4013
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| docs_path = os.path.join(self.root_path, docs_dir) | ||
|
|
||
| # RTD javascript writing | ||
| rtd_data = self.generate_rtd_data(docs_dir=docs_dir, mkdocs_config=user_config) | ||
| with open(os.path.join(docs_path, 'readthedocs-data.js'), 'w') as f: | ||
| f.write(rtd_data) | ||
|
|
||
| # Use Read the Docs' analytics setup rather than mkdocs' | ||
| # This supports using RTD's privacy improvements around analytics | ||
| user_config['google_analytics'] = None |
There was a problem hiding this comment.
Should we delete this, instead of setting it to None?
There was a problem hiding this comment.
I use del extremely rarely, but I don't have a particularly strong opinion.
| analytics_code = self.version.project.analytics_code | ||
| if not analytics_code and mkdocs_config.get('google_analytics'): | ||
| # http://www.mkdocs.org/user-guide/configuration/#google_analytics | ||
| analytics_code = mkdocs_config['google_analytics'][0] |
There was a problem hiding this comment.
Is this always a list? Feels a bit brittle and might just grab one character if it's just a string.
There was a problem hiding this comment.
The docs link leads me to believe it is a list. I'm fine being a bit more defensive here.
There was a problem hiding this comment.
Actually, it looks like that is probably unnecessary: https://github.com/mkdocs/mkdocs/blob/71ebf35/mkdocs/config/defaults.py#L51-L53
There was a problem hiding this comment.
It is guaranteed to be either null or a 2-tuple
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Read the Docs has implemented some privacy enhancements for authors who opt to enable Google Analytics on their projects. This change enables those for MkDocs projects.
For example, the mkdocs project (a documentation project that uses mkdocs itself) specifies their own Google Analytics code in their
mkdocs.yml. When MkDocs builds the docs, the Google analytics snippet is injected directly into the output. However, Read the Docs already supports user GA analytics codes and has enabled some improvements around there such as anonymizing visitor IPs. Without this change, MkDocs projects bypass these protections which can result in reduced privacy or possibly double counting in analytics (if the analytics code is specified in RTD and inmkdocs.yml). By hooking into the RTD setup, we can enable those privacy enhancements for people who specify their Google Analytics setup inmkdocs.ymland ensure there's no double counting.