跳转到主要内容

Sphinx 扩展,允许.toc文件构建目录表

项目描述

sphinxcontrib-toc 是一个Sphinx扩展,允许.toc文件构建目录表。

此扩展使您能够使用无法定义目录树的标记语言构建复杂文档。具体来说,与recommonmark结合使用时,您不需要在文档中编写任何reStructuredText!

使用方法

在conf.py中添加此扩展

extensions = ['sphinxcontrib.toc']

并配置以下设置

toc_title

如果.toc文件中没有标题,则toctree的默认标题。默认为 "{project} 文档"

toc_numbered

与toctree指令的 :numbered: 选项相同。如果启用,Sphinx将分配章节编号。默认为 true

.toc文件

.toc文件类似于toctree指令的文档列表

section1
section2
section3

您可以在文件顶部定义toctree的标题

# The title of document
section1
section2
section3

小贴士

您可以使用“嵌套”的.toc文件,如下所示

/index.toc
/part1.rst
/part2.rst
/part3/index.toc
/part3/section1.toc
/part3/section2.toc

# In /index.toc
part1
part2
part3/index

# In /part3/index.toc
section1
section2

项目详情


下载文件

下载适合您平台的应用程序。如果您不确定要选择哪个,请了解有关 安装包 的更多信息。

源分发

sphinxcontrib-toc-1.0.0.tar.gz (3.4 kB 查看哈希值)

上传时间: 源码

构建版本

sphinxcontrib_toc-1.0.0-py2.py3-none-any.whl (3.6 kB 查看哈希值)

上传时间: Python 2 Python 3

支持者