Sphinx中类链接的较短名称

Shorter name for the class link in Sphinx(Sphinx中类链接的较短名称)
本文介绍了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显示ClassDepartment?

推荐答案

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

如果为内容添加前缀~,则链接文本将只是目标的最后一个组件。例如,

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

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

还有.. currentmodule::和example in another SO answer指令.. currentmodule::

这篇关于Sphinx中类链接的较短名称的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Leetcode 234: Palindrome LinkedList(Leetcode 234:回文链接列表)
How do I read an Excel file directly from Dropbox#39;s API using pandas.read_excel()?(如何使用PANDAS.READ_EXCEL()直接从Dropbox的API读取Excel文件?)
subprocess.Popen tries to write to nonexistent pipe(子进程。打开尝试写入不存在的管道)
I want to realize Popen-code from Windows to Linux:(我想实现从Windows到Linux的POpen-code:)
Reading stdout from a subprocess in real time(实时读取子进程中的标准输出)
How to call type safely on a random file in Python?(如何在Python中安全地调用随机文件上的类型?)