Sphinx:删除特定功能的包和模块名称

时间:2017-04-28 12:18:41

标签: python python-sphinx

我的问题非常类似于Remove package and module name from sphinx function

有没有办法在sphinx中删除/隐藏软件包和模块名称仅用于单个函数或至少用于文件中的每个函数(基本上在本地更改全局conf.py设置),同时显示其余部分该项目?

我已经找到了一些选项,比如automodule(:members:,:undoc-members:等),但我找不到任何隐藏此信息的指令。

1 个答案:

答案 0 :(得分:2)

一个选项是对http://localhost:3000/public/plugins/grafana-my-datasource/module.js使用reST标记,如下所示:

  

如果您在内容前加~,则链接文本将只是目标的最后一个组成部分。例如,

     

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

     

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