在文档中添加注释和注释。
sphinx-comments的Python项目详细描述
斯芬克斯评论
|
添加注释和注释功能到您的斯芬克斯网站。在
目前支持这些评论引擎：
- Hypothes.is提供了一个web覆盖，允许您协作地进行注释和注释。在
- utteranc.es是一个使用GitHub问题来存储和管理评论的web评论系统。在
- ^{
} 是一个基于web标准的开源注释和注释覆盖。在
对于每个服务的示例，以及如何激活它的说明，
see the ^{
投稿斯芬克斯评论
斯芬克斯注释在the Executable Books contributing guide之后。在
安装用于开发
要安装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注释尽量轻量级。它只是：
- 为web注释和注释平台加载Javscript库
- 为支持它的平台提供配置层
请注意，有些平台不能同时激活，用户 需要选择其中一个。在
一些注释平台需要更复杂的设置-例如，utteranc.es要求将其脚本放在页面上的特定位置，因此sphinx-comments会将其直接放在页面的doctree中（在内容下方）。在
- 项目
标签：
欢迎加入QQ群-->： 979659372
