分析和使用服务

该主题通过 analytics 选项支持多种网络分析服务。它通过传递包含选项的字典进行配置。有关您要使用的分析提供商的相关选项，请参阅以下部分。

html_theme_options = {
    # See below for options for each service
    "analytics": analytics_options,
}

一般来说，我们推荐使用 Plausible 而不是 Google Analytics，因为它在用户安全和隐私方面拥有更好的故事。此外，它更加开源和透明。事实上，您可以自托管 Plausible 服务器.

在 scientific-python.org 上获取自托管的 Plausible 服务器

如果您的文档是 SciPy / PyData 生态系统中的一部分，他们可能能够在 https://views.scientific-python.org/<your-package> 上为您托管 Plausible 服务器。要询问此事，请在您选择的社交媒体平台上与他们联系，并在 scientific-python.org 上了解更多信息。

Plausible 分析

plausible.io 可用于收集网站的简单且注重隐私的分析。要配置，您需要提供两件事

• 指向由您的 Plausible 服务器提供的 JavaScript 分析脚本的 URL

• 反映您的文档所在位置的域

Plausible 的 JavaScript 将包含在所有 HTML 页面中以收集指标。包含分析结果的仪表板将在 https://<plausible-url>/<my-domain> 上可用。

html_theme_options["analytics"] = {
    # The domain you'd like to use for this analytics instance
    "plausible_analytics_domain": "my-domain",
    # The analytics script that is served by Plausible
    "plausible_analytics_url": "https://.../script.js",
}

另请参阅

有关此脚本的更多信息，请参阅 Plausible 文档.

Google Analytics

如果指定了 google_analytics_id 配置选项（如 G-XXXXXXXXXX），则 Google Analytics 的 JavaScript 将包含在 HTML 页面中。

html_theme_options["analytics"] = {
    "google_analytics_id": "G-XXXXXXXXXX",
}