Skip to main content

Subprojecttoctrees 是一个 Sphinx 扩展,旨在促进将多个文档源集成到一个 Read the Docs 网页中。

项目描述

子项目目录树

Subprojecttoctrees 是一个Sphinx扩展,旨在促进将多个文档源集成到一个 Read the Docs网页中。该项目扩展了 Read the Docs 子项目 概念,通过在这些项目之间创建统一的 URL 侧边栏,允许将项目配置为另一个项目的子项目。在“主”项目中指定了一个“主”索引,无需更新所有子项目以更改索引并允许特定于版本的侧边栏链接。

文档

文档可以在这里找到。

如何安装

安装前,建议先创建虚拟环境。在此处了解有关虚拟环境的更多信息。

您可以从 Python 包索引 (PyPI)安装二进制包

pip install sphinx-subprojecttoctree

更多信息可以在 文档中找到

依赖项

这个项目是Sphinx的插件。

Python 版本支持

正式支持 Python 3.8、3.9 和 3.10。

运行测试

要运行测试,请执行tox.

执照

麻省理工学院

项目详情


下载文件

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

源分布

sphinx-subprojecttoctree-0.4.0.tar.gz (215.8 kB 查看哈希)

已上传 source

内置分布

sphinx_subprojecttoctree-0.4.0-py3-none-any.whl (7.2 kB 查看哈希

已上传 py3