增强Sphinx TocTree，可以将类、函数等显示为章节。
项目描述
增强Sphinx TocTree，可以将类、函数等显示为章节。
文档 |
|
|---|---|
测试 |
|
PyPI |
|
Anaconda |
|
活动 |
|
QA |
|
其他 |
|
此想法已在 sphinx-doc/sphinx#6316 和 sphinx-doc/sphinx#6435 中提出
您可以在 此项目的文档 中看到 toctree-plus 的实际应用，以及 domdf-python-tools（ReadTheDocs Sphinx主题）和 whey（Furo Sphinx主题）的文档。
安装
toctree_plus 可以从PyPI或Anaconda安装。
使用 pip 安装
$ python -m pip install toctree_plus使用 conda 安装
首先添加所需通道
$ conda config --add channels https://conda.anaconda.org/conda-forge $ conda config --add channels https://conda.anaconda.org/domdfcoding
然后安装
$ conda install toctree_plus
通过在 conf.py 文件的 extensions 变量中添加 "sphinxcontrib.toctree_plus" 来启用 toctree_plus
extensions = [
...
"sphinxcontrib.toctree_plus",
]更多信息请参阅 https://sphinx-doc.cn/en/master/usage/extensions/index.html#third-party-extensions。
配置
目前只有一个配置选项： toctree_plus_types。该选项确定出现在 toctree 中的指令类型。默认值是 {"class", "function", "method"}。
链接
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源代码分发
toctree_plus-0.8.0.tar.gz (7.6 kB 查看哈希值)
构建分发
toctree_plus-0.8.0-py3-none-any.whl (7.9 kB 查看哈希值)
关闭
toctree_plus-0.8.0.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 095a865f2eaa4d654a9a1b46a6f53805500aea72404fbb27dde509e8401f1340 |
|
| MD5 | de5125b8000db0100a76360ed3bdcecc |
|
| BLAKE2b-256 | ad393a37606982c65ab5723768c455ef8291e29b1884d455cb6625b239b77809 |
关闭
toctree_plus-0.8.0-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 80717d485db6eb3c9bff92df6544b4bf020e15757ad14c39a104288ee1485ebe |
|
| MD5 | 07ac8e6b0328c1ea6ef062f57e724d95 |
|
| BLAKE2b-256 | d8ba9edc4197d4c92792bab1f36f97bfba60d60b7a3de9a58c0a40b3d235a049 |
