4

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.

bad_coder
  • 11,289
  • 20
  • 44
  • 72
Jan
  • 4,932
  • 1
  • 26
  • 30

0 Answers0