知识卡片

操作参考卡 · 1958.c.12.a.1.li · 生成模型:未记录

目录树表达跨文档关系

理解等级:中级

Sphinx的toctree按相对源文档名组织子文档,支持深度和glob等选项,并参与前后页导航;它不同于reST contents只列当前文档标题。通配符能减少手工漏列,也可能带入不该公开的内容,应控制范围与排序。只生成目录不保证每个任务都有合适说明。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元019;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。 - 结论依据:原文toctree指向子文档并形成导航,支持跨文件结构;contents只列文内标题,通配范围仍需防止错误公开或排序。补充核验入口:https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html。未在本机运行示例或改变环境。 - 原始内容:添加元素的标记。 (1)在索引页上工作 Sphinx提供了一个 toctree 指令,可以用来在文档中插入一个目录,其中包含指向其他文档的链接。每行必须是具有相对路径的文件,从当前文档开始。全局风格的名称可以通过与表达式匹配添加多个文件。 例如,我们以前