从sphinx函数中删除包和模块名称

时间:2013-12-31 23:59:43

标签: python-sphinx

是否可以从sphinx doc中删除软件包和/或模块名称?

示例:如果在模块foo.bar中存在一个名为waa的函数,则为第一个代码

.. automodule:: foo.bar
    :members:

将生成

foo.bar.waa()

我要输出

waa()

1 个答案:

答案 0 :(得分:23)

您可以将文件add_module_names中的False更改为conf.py

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False

然后foo.bar.my_function()将显示为my_function()