sphinx autodoc动态继承

时间:2017-09-28 13:47:06

标签: python inheritance python-sphinx autodoc

我是新手使用Sphinx并在使用autodoc函数(sphinx-apidoc)时偶然发现问题。

我的一个模块定义了一个使用动态继承的函数,如下所示:

def generate_object(base_class, *args, **kwargs):
    """This function create a new class that inherits base_class
    """

    class NewClass(base_class):
        """Class that inerherits the base_class
        """

        def __init__(self, *args, **kwargs):
            super(NewClass, self).__init__(*args, **kwargs)
            pass

    return NewClass(*args, **kwargs)

然后我在sphinx-quickstart文件夹中使用标准docs并使用

创建必要的.rst文件
sphinx-apidoc -f -o source/ ../

make html文件夹运行docs后,生成的网站会显示generate_object方法的文档,但不显示NewClass的文档。如何确保生成NewClass的文档并在文档中显示?

可以找到代码here和文档here

0 个答案:

没有答案