gpt4 book ai didi

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

转载 作者:太空宇宙 更新时间:2023-11-03 15:02:20 25 4
gpt4 key购买 nike

我使用 automodule 从文档字符串生成文档,如下所示:

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

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

Screenshot of documentation

每次我使用 members 关键字时,都会重复此文档。如何从 sqlalchemy 中删除这些附加文档和示例?

最佳答案

automodule有一个选项exclude-members:

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

关于python-sphinx automodule 甚至可以为第三方模块的方法生成文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/44957075/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com