Sphinx 评论¶
为你的 Sphinx 网站添加评论和注释功能。
目前,支持这些评论引擎:
Hypothes.is 提供了一个网络覆盖,使你能够注释和协作评论。
utteranc.es 是一个网络评论系统,使用 GitHub issue 来存储和管理评论。
dokie.li
是一个建立在网络标准上的开源评论和注释覆盖。
关于每项服务的例子,以及如何激活它的说明,请点击左边的链接。
安装¶
克隆并安装 github 资源库
pip install sphinx-comments
接下来,通过将其添加到你的 conf.py
文件中来激活这个扩展。
...
extensions = [
"sphinx_comments"
]
配置¶
要配置 sphinx-comments
(并选择你想使用的引擎),你应该在 conf.py
中配置 comments_config
字典。这样做的说明可以在下面每个支持的引擎的页面中找到。