更短的autodoc名称

时间:2015-08-07 11:32:26

标签: python python-sphinx autodoc

我在我的Python包中使用Sphinx和autodoc,这样可以获得很好的文档,但默认情况下是完整的"路径"功能,例如:

SomeFolder.AnotherFolder.MyModule.FunctionName(arg1, arg2, arg3)

因为很清楚模块的位置,调用我的部分的方式,并且因为如果有很长的参数名称我得到换行符,我想有一个更短的名字,比如

MyModule.FunctionName(arg1, arg2, arg3)

我假设有一些选项可以传递给自动功能,如

.. autofunction:: SomeFolder.AnotherFolder.MyModule.FunctionName
    :someoption:

但我无法在http://sphinx-doc.org/ext/autodoc.html

找到它

P.S:在自动功能调用中省略文件夹名称,即

.. autofunction:: MyModule.FunctionName

导致Sphinx找不到该函数(和空文档)

0 个答案:

没有答案