知识卡片

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

索引和交叉引用需注册语义

理解等级:中级

Sphinx模块指令可登记模块身份,index增加检索条目,:mod:等角色引用相应对象,帮助读者从不同入口找到同一说明。它们属于Sphinx扩展语义,不能假定所有Docutils输出都识别;index的单项、多项写法也要按语法确认,不能把示例折行丢失后的文本当正确条目结构。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元019;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。 - 结论依据:原文模块指令、index和mod角色分别登记与引用对象,支持工具语义先注册再解析,不能假设任意Docutils转换均识别Sphinx扩展。补充核验入口:https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html。未在本机运行示例或改变环境。 - 原始内容:的HTML版本的示例 构建目录的指令。 将文档注册为模块助手的标记。 在索引中添加元素的标记。 (1)在索引页上工作 Sphinx提供了一个 toctree 指令,可以用来在文档中插入一个目录,其中包含指向其他文档的链接。每行必须是具有