如何使用只有函数的一个.py文件制作一个sphinx doc?

时间:2014-02-06 23:48:59

标签: python documentation python-sphinx

如何使用仅包含函数的.py文件制作sphinx文档?

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

感谢大家的帮助。

1 个答案:

答案 0 :(得分:2)

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

像往常一样设置你的狮身人面像文档,并在.rst文件中有类似的内容:

.. automodule:: myfile
   :members: