Python Sphinx如何列出模块的函数名称

Question

如何列出函数的名称和摘要？

现在我有

.. automodule:: module_dir.module_name
   :members:

哪个返回每个函数的整个文档字符串，对我来说太多了。是否可以选择限制输出或仅获取函数名称？

Answer 1

这部分代码需要添加到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)