2

如何使用一个只有功能的 .py 文件制作 Sphinx 文档?

我有一个 .py 文件,其中包含多个函数,其中已经包含文档字符串,但不想:function:: console.someFunction为所有函数创建一个。是否有更智能或更好的方法来遍历所有功能?

4

1 回答 1

3

是的,有可能,您需要的是autodoc。不要忘记将 sphinx.ext.autodoc 添加到 conf.py。

像往常一样设置您的 sphinx 文档,并且在您的 .rst 文件中包含以下内容:

.. automodule:: myfile
   :members:
于 2014-02-06T23:51:30.247 回答