[3.13] Add Plausible for docs metrics (GH-119977) (#120193)

miss-islington · hugovk · JulienPalard · web-flow · commit 0e6605f633f3 · 2024-06-07T10:42:19.000+03:00
Co-authored-by: Hugo van Kemenade &lt;1324225+hugovk@users.noreply.github.com&gt;
Co-authored-by: Julien Palard &lt;julien@palard.fr&gt;
diff --git a/Doc/conf.py b/Doc/conf.py
@@ -339,7 +339,8 @@
 html_context = {
     "is_deployment_preview": os.getenv("READTHEDOCS_VERSION_TYPE") == "external",
     "repository_url": repository_url.removesuffix(".git") if repository_url else None,
-    "pr_id": os.getenv("READTHEDOCS_VERSION")
+    "pr_id": os.getenv("READTHEDOCS_VERSION"),
+    "enable_analytics": os.getenv("PYTHON_DOCS_ENABLE_ANALYTICS"),
 }
 
 # This 'Last updated on:' timestamp is inserted at the bottom of every page.
diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html
@@ -26,6 +26,9 @@
 {% endblock %}
 
 {% block extrahead %}
+    {% if builder == "html" and enable_analytics %}
+      <script defer data-domain="docs.python.org" src="https://plausible.io/js/script.js"></script>
+    {% endif %}
     <link rel="canonical" href="https://docs.python.org/3/{{pagename}}.html" />
     {% if builder != "htmlhelp" %}
       {% if pagename == 'whatsnew/changelog' and not embedded %}

Original file line number	Diff line number	Diff line change
`@@ -339,7 +339,8 @@`
`339`	`339`	`html_context = {`
`340`	`340`	`"is_deployment_preview": os.getenv("READTHEDOCS_VERSION_TYPE") == "external",`
`341`	`341`	`"repository_url": repository_url.removesuffix(".git") if repository_url else None,`
`342`		`- "pr_id": os.getenv("READTHEDOCS_VERSION")`
	`342`	`+ "pr_id": os.getenv("READTHEDOCS_VERSION"),`
	`343`	`+ "enable_analytics": os.getenv("PYTHON_DOCS_ENABLE_ANALYTICS"),`
`343`	`344`	`}`
`344`	`345`
`345`	`346`	`# This 'Last updated on:' timestamp is inserted at the bottom of every page.`