分析与使用服务

该主题通过 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/<您的包名> 为您托管 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",
}