我正在使用sphinx为我们的Python API生成文档。 Python API中的许多函数实际上是SWIG包装的C / C ++ / Fortran函数。我希望包装的函数出现在我的API文档中,但是它们没有文档字符串,因此默认情况下不显示。我对在文档中出现私有功能/方法/属性不感兴趣,但是当我提供:undoc-members:指令时,它们确实起作用。
如何仅显示公共名称,包括不带文档字符串的项目名称?
我对模块配置的最佳尝试:
.. automodule:: company.category.tool
:autodoc_member_order: bysource
:members:
:undoc-members:
:no-show-inheritance:
:no-private-members:
:no-ignore-module-all:
:exclude-members: this,thisown,acquire,disown,own
(:no-ignore-module-all:
是必需的,因为包装名称是从编译的库中导入的,并在__all__
中列出。否则将被忽略):no-private-members:
似乎被忽略了。