18.6 更复杂的标记技术

    还有一些标记技术可以让文档更易读。尤其是,我们通常希望在类定义中创建有用的交叉引用。我们可能也希望为一个文档中的节和主题创建交叉引用。

    在纯RST(就是没有Sphinx)中,我们需要提供引用了文档不同部分的正确URL,我们有以下3种引用。

    • 隐式的节标题引用:可以用'Some Heading'_引用Some Heading节。这可以应用于所有docutils能够识别的标题。
    • 显式的目标引用:可以用target_引用_target在文档中的位置。
    • 文档内引用:必须创建显式引用节标题的完整URL。docutils会将节标题翻译为小写,并且用-替换标点符号。这允许我们在外部的文档中创建指向节标题的引用,类似这样:'Design '_。

    当我们使用Sphinx时,我们会获得更多文档内、交叉引用的能力。这些能力使得我们避免编写包含大量细节的URL。