sphinx autodoc include subfunctions

白昼怎懂夜的黑 提交于 2019-12-23 14:40:52

问题


I want to automatically include subfunctions of a function in the sphinx documentation. What is the option for this?

My code looks like

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

    """

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

        """

By now I set in the included code.rst

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

.. automodule:: lqgbt_lnse
   :members:

But the output by sphinx includes only the mainfunction.

来源:https://stackoverflow.com/questions/22451195/sphinx-autodoc-include-subfunctions

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!