Sphinx Comments

|

为您的 Sphinx 网站添加评论和注释功能。

目前支持以下评论引擎

• hypothes.is 提供一个网页覆盖层，允许您协作注释和评论。
• utteranc.es 是一个使用 GitHub Issues 存储和管理评论的网页评论系统。
• dokie.li 是一个基于 Web 标准的开源注释和注释覆盖层。

有关每个服务的示例以及如何激活它的说明，请参阅 sphinx-comments 文档。

为 Sphinx Comments 做出贡献

Sphinx Comments 遵循 可执行书籍贡献指南。

为开发安装

要为开发安装 sphinx-comments，请执行以下步骤

git clone https://github.com/executablebooks/sphinx-comments
cd sphinx-comments
pip install -e .[testing,sphinx]

这将安装开发测试所需的依赖项。

仓库结构

Sphinx Comments 是一个轻量级的 Sphinx 扩展，它激活了几个 JavaScript 库以供 Sphinx 使用。其所有功能都包含在 sphinx_comments/__init__.py 中。

作为一般规则，Sphinx Comments 尽量保持轻量。它只是

• 加载 Web 评论和注释平台的 JavaScript 库
• 为支持它的平台提供配置层

请注意，某些平台不能同时激活，用户需要选择其中之一。

一些注释平台需要更复杂的设置 - 例如，utteranc.es 需要将脚本放置在页面上的特定位置，因此 sphinx-comments 将其直接放置在页面的 doctree 中（内容下方）。