sphinxext-delta

Sphinx 扩展，用于在 ReadTheDocs 上生成更改文章的页面。

安装

python -m pip install sphinxext-delta

需求

• Sphinx >= 2
• ReadTheDocs
• GitHub

不支持其他环境。

使用

将 sphinxext.delta 添加到您的 conf.py 文件中的扩展列表中

extensions = [
    sphinxext.delta,
]

选项

有 2 个必需的配置和 1 个可选配置

• delta_doc_path
  • 必需: 文章的相对路径。例如: source/docs
• delta_inject_location
  • 可选: 要注入的 toctree 的相对位置。默认为 master_doc。