Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/python/323.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Python 为函数中定义的类生成文档_Python_Python Sphinx - Fatal编程技术网

Python 为函数中定义的类生成文档

Python 为函数中定义的类生成文档,python,python-sphinx,Python,Python Sphinx,使用下面的源代码,我想为函数中定义的类foo生成文档 # module named rubbish.py def factory(): class foo: def bar(self): '''bar ''' pass 相应的rst文件看起来是这样的 rubbish module ============== .. automodule:: rubbish :members: :u

使用下面的源代码,我想为函数中定义的类foo生成文档

# module named rubbish.py
def factory():
    class foo:
        def bar(self):
            '''bar
            '''
            pass
相应的rst文件看起来是这样的

rubbish module
==============

.. automodule:: rubbish
    :members:
    :undoc-members:
    :show-inheritance:
并且不会生成类文档。生成的html仅显示factory()


是否也有任何指令来记录该类?

我设法以一种可能是迂回的方式完成了这项工作,但它似乎起到了作用

  • 我还没有“从头开始”测试过这个
  • 我正在使用autodoc
代码 my_module.py:

#这里是类工厂
def foo_工厂():
Foo类:
“我的足球课很酷”
定义初始化(自):
“这是一个Foo”
Params
------
等
'''
通过
def bar(自):
''去酒吧!
Params
------
等
'''
返回1+1

foo_factory.class_example=foo#我不确定这是否可行。类似问题:,
.. autoclass:: Foo
   :members: