如何选择与Sphinx交叉引用时使用的文本?

问题描述 投票:0回答:1

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

.. _struct_NiO:

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

   long long very long caption ...

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

See figure :ref:`struct_NiO` bla bla bla

以便对图进行交叉引用。这可行,但输出看起来像:

见图“长长长长的标题……”bla bla bla。

这是 sphinx 的正常行为,但如果你的图形有点复杂,带有 3 或 4 行标题,那么它就不太适合。

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

python-sphinx cross-reference
1个回答
14
投票

您可以为

:ref:
目标提供自定义链接文本,如下所示:

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

标签括在尖括号内。

请参阅 https://www.sphinx-doc.org/en/master/usage/referencing.html#role-ref

© www.soinside.com 2019 - 2024. All rights reserved.