Sphinx中类链接的较短名称

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

   Class :class:`apps.business.models.Department`
      Explanation goes here

   `GNU tar manual, Basic Tar Format <http://link>`_
      Documentation for tar archive files, including GNU tar extensions.

这创建了一个到班级部门的正确链接。

enter image description here

如何在不使用“apps.business.models”前缀的情况下将HTML输出更改为只有一个类名?

so it reads Class Department in HTML?

python python-sphinx
1个回答
1
投票

~standard cross-referencing syntax(代字号)。

如果在内容前加上〜,则链接文本将只是目标的最后一个组件。例如,

:py:meth:`~Queue.Queue.get`

将引用Queue.Queue.get但仅显示get作为链接文本。这不适用于所有交叉引用角色,但是特定于域。

还有指令.. currentmodule::some documentationexample in another SO answer

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