首页 > 解决方案 > 如何 AutoDoc 文档从函数 DocString 中排除 SQLAlchemy 库 DocString?

问题描述

我试图从作为我的项目的参考文档生成 autodoc 字符串。但是,由于我的源代码使用导入并使用 SQLAlchemy 库,所以当我发布

sphinx-apidoc -f -o docs/source/reference project

生成的文档不仅包括来自我的函数的文档字符串,还包括来自 SQLAlchemy 的文档字符串,就像这样

在此处输入图像描述

无论如何我可以从我的函数文档字符串中排除 SQLAlchemy 文档字符串吗?谢谢

标签: pythonpython-sphinx

解决方案


推荐阅读