python-sphinx - 如何选择与 Sphinx 交叉引用的文本？

Question

使用 sphinx，我使用以下语法包含了一个图形。

.. _struct_NiO:

.. figure:: img/NiO.png
   :align: center
   :width: 400px

   long long very long caption ...

在我使用的另一部分文本中

See figure :ref:`struct_NiO` bla bla bla

为了对图进行交叉引用。这项工作，但输出看起来像：

见图“long long很长标题...” bla bla bla。

这是 sphinx 的正常行为，但是如果您的图形有点复杂，带有 3 或 4 行标题，则它并没有真正适应。

是否可以选择交叉引用中使用的文本？

Answer 1

您可以为目标提供自定义链接文本:ref:，如下所示：

See figure :ref:`Link text <struct_NiO>` bla bla bla

请参阅http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role。