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.
这将创建到类Department的适当链接。
如何将HTML输出更改为只有一个类名,而不使用‘apps.Bus.Models’前缀?
所以它以HTML显示Class Department?
解决方案
standard cross-referencing syntax中有~
(波浪号)。
如果为内容添加前缀~,则链接文本将只是目标的最后一个组件。例如,
:py:meth:`~Queue.Queue.get`
将引用
Queue.Queue.get
,但仅显示get
作为链接文本。这不适用于所有交叉引用角色,但特定于域。
还有.. currentmodule::
和example in another SO answer指令.. currentmodule::
。
相关文章