python-sphinx automodule甚至为来自第三方模块的方法生成文档

时间:2017-07-06 19:09:40

标签: python python-sphinx

我使用automodule从docstrings生成文档,如下所示:

.. automodule:: cdbus.csdb.chemnavi.db.schema
    :members:

但是当使用:members:时,它还为sqlalchemy生成了文档和示例代码,这不在我的模块中。我刚刚导入了sqlalchemy来编写我的模块。

Screenshot of documentation

每次使用members关键字时,都会重复此文档。如何从sqlalchemy中删除那些额外的文档和示例?

1 个答案:

答案 0 :(得分:1)

automodule有一个选项exclude-members

.. automodule:: cdbus.csdb.chemnavi.db.schema
    :members:
    :exclude-members: this, that, other