Python Sphinx:删除特定函数的包和模块名称
我的问题与这里的问题非常相似: 是否有办法在sphinx中删除/隐藏仅针对单个函数或至少针对文件中的每个函数的包和模块名称(基本上在本地更改全局conf.py设置),同时在项目的其余部分显示它们Python Sphinx:删除特定函数的包和模块名称,python,python-sphinx,Python,Python Sphinx,我的问题与这里的问题非常相似: 是否有办法在sphinx中删除/隐藏仅针对单个函数或至少针对文件中的每个函数的包和模块名称(基本上在本地更改全局conf.py设置),同时在项目的其余部分显示它们 我已经查找了一些选项,例如automodule(:members:,:undoc members:等)的选项,但我找不到任何隐藏此信息的指令。一个选项是使用reST标记进行类似操作: 如果在内容前面加上~,则链接文本将仅是目标的最后一个组件。比如说, :py:meth:`~Queue.Queue.get
我已经查找了一些选项,例如automodule(:members:,:undoc members:等)的选项,但我找不到任何隐藏此信息的指令。一个选项是使用reST标记进行类似操作: 如果在内容前面加上
~
,则链接文本将仅是目标的最后一个组件。比如说,
:py:meth:`~Queue.Queue.get`
将引用Queue.Queue.get
,但仅将get
显示为链接文本
谢谢你的回复。如果我想在某个地方引用该函数,它会工作得很好。这对autodoc指令(…autofunction::package1.subpack1.subpack2.mymodule1.function1)是否起作用。为函数生成的行非常大,在其中隐藏包和子包名称是有意义的。AFAIK,您可以使用全局设置,但不能基于每个文件或函数。您可以研究输出的后处理。