sphinx autodoc包括子功能

时间:2014-03-17 09:53:36

标签: python python-sphinx

我想在sphinx文档中自动包含函数的子函数。这有什么选择?

我的代码看起来像

import numpy
def mainfunc():
    """ to be documented 

    """

    def subfunc():
        """ to be documented as well

        """

到目前为止,我已经设置了所包含的code.rst

Code Reference
==============

.. automodule:: lqgbt_lnse
   :members:

但是sphinx的输出只包括main函数。

0 个答案:

没有答案