[英]Python sphinx how to list functions' names of module
如何列出函数的名称和摘要?
现在我有
.. automodule:: module_dir.module_name
:members:
它返回每个函数的整个文档字符串,这对我来说太多了。 是否可以选择限制输出或仅获取函数名称?
这部分代码需要添加到conf.py中,以摆脱所有文档字符串。
def process_docstring(app, what, name, obj, options, lines):
"""
Deletes unnecessary docstring
"""
if what != "module":
del lines[:]
def setup(app):
app.connect('autodoc-process-docstring', process_docstring)
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.