Sphinx中类链接的简称

时间:2018-09-18 21:59:53

标签: python python-sphinx

.. 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

如何将HTML输出更改为仅具有一个类名,而没有'apps.business.models '前缀?

所以它读取HTML中的Class Department?

1 个答案:

答案 0 :(得分:1)

standard cross-referencing syntax中有~(波浪号)。

  

如果在内容前面加上〜,则链接文本将仅是目标的最后一个部分。例如,

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

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

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