什么'_glossary'和'_contents'指令在Sphinx中做什么?

时间:2014-01-16 19:31:10

标签: python documentation markup python-sphinx

在许多软件包的文档中,包括Sphinx本身,我在表格的某些文件的开头看到了一个指令

.. _<filename>:

例如,many glossaries

开头
.. _glossary:

这些指令做了什么以及它们在哪里记录?


请注意,我将其省略,例如,我的'glossary.rst',然后:ref:glossary链接到python.org上的Python词汇表,而不是我的词汇表,因此该指令正在做一些重要的事情。

1 个答案:

答案 0 :(得分:1)

.. _glossary:等指令是标签,用于标识文档中的一个点(链接目标)。

使用此标记创建指向该位置的链接::ref:`glossary`。有关详细信息,请参阅http://sphinx-doc.org/markup/inline.html#ref-role

是的,如果您使用intersphinx扩展名(配置如下:intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)})并使用上述链接而未定义您自己的.. _glossary:标签,则输出中的结果链接确实会指向http://docs.python.org/2.7/glossary.html#glossary