【问题标题】:Sphinx: cross-reference indexed itemSphinx:交叉引用索引项
【发布时间】:2011-01-29 14:04:33
【问题描述】:

如何交叉引用 reStructuredText 文档中的索引项?

例如,如何交叉引用SectionB:

.. index::
    pair: SectionA; SectionB

SectionB
--------

SectionB description.

我尝试在引用中使用索引标签,例如:

:ref:`SectionB`

但这不起作用。

【问题讨论】:

  • 你真的在使用 :ref:'SectionB' 而不是 :ref:`SectionB` 吗?你应该使用反引号......
  • 我正在使用反引号,但 Markdown 将它们用作内联代码跨度,所以我只是将示例更改为使用 ''

标签: python-sphinx restructuredtext cross-reference


【解决方案1】:

见:Cross-referencing arbitrary locations

在 Sphinx 文档中。

我认为您可能缺少的是参考标签,

尝试类似:

.. index::
pair: SectionA; SectionB

.. _section-b-label:

SectionB
--------

SectionB description.

然后在其他地方做:

:ref:`section-b-label`

【讨论】:

  • 我知道我可以使用参考标签。我试图避免的是必须同时添加索引和参考标签。好像有点多余。
【解决方案2】:

如果不添加自定义标签,这个选项似乎仍然是不可能的。 https://github.com/sphinx-doc/sphinx/issues/1671 有一个问题未解决

可以使用:term: 链接到词汇表术语,理想情况下可以将索引链接添加到arbitrary links docs

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2017-03-14
    • 1970-01-01
    • 1970-01-01
    • 2012-12-31
    • 1970-01-01
    • 1970-01-01
    • 2016-02-26
    相关资源
    最近更新 更多