Sphinx：删除特定函数的包和模块名称 [英] Sphinx: Remove package and module name for specific function

问题描述

我的问题与这里的问题非常相似：Remove package and module name from sphinx function

有没有办法只为单个函数或至少为文件中的每个函数删除/隐藏Shinx中的包和模块名称(基本上是在本地更改全局conf.py设置)，同时为项目的其余部分显示它们？

我一直在寻找选项，例如自动模块(：Members：，：UNDOC-Members：等)，但我找不到任何隐藏此信息的指令。

推荐答案

一个选项是对cross referencing syntax使用REST标记，如下所示：

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

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

将引用Queue.Queue.get，但仅显示get作为链接文本。

这篇关于Sphinx：删除特定函数的包和模块名称的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！