蟒-斯芬克斯automodule生成文档甚至用于从第三方模块

我用automodule从文档字符串生成文档的方法，如下所示：蟒-斯芬克斯automodule生成文档甚至用于从第三方模块

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

但是用:members:它也生成的文档和示例代码SQLAlchemy的时，这不在我的模块中。我只是导入了sqlalchemy来写我的模块。

Screenshot of documentation

而这个文件是重复我每次使用members关键字的时间。我如何从sqlalchemy中删除这些额外的文档和示例？

来源

2017-07-06 Hitesh Patel

我认为，我们需要以解释正在发生的事情更多地了解“cdbus”。你的代码是做什么的？与SQLAlchemy的关系究竟是什么？如何再现问题？ – mzjn

包和文件太大了，我正在解释它如何导入模块。 cdbus是我写的化学数据库和使用sqlalchemy的模块。在cdbus的base.py文件定义连接到下列库MySQL的星展银行和进口：从SQLAlchemy的进口and_，or_，not_ 从sqlalchemy.types导入BLOB作为Blob 从sqlalchemy.ext.declarative进口declarative_base ＃全进口AR enot 在此模块中，cdbus/csdb/chemnavi/db/schema.py中有一个模式文件，它定义了一个mysql模式。它导入cdbus.base –

仍然没有足够的信息。如何再现问题？你自己写了任何文档吗？它们是否显示在输出中？在屏幕截图中，显示的所有文档都来自SQLAlchemy。如果您有更多要添加的细节，请通过编辑问题而不是添加注释来提供。 – mzjn

automodule有一个选项exclude-members：

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

来源

2017-07-06 19:43:02

因此，每次生成文档后，我都应该检查生成哪些其他文档，并将其排除。但是，是否没有任何选项可以严格禁止从导入的模块生成文档？ –

蟒-斯芬克斯automodule生成文档甚至用于从第三方模块

回答

相关问题