python - Sphinx autmodule 还记录了导入的模块

Question

我正在使用 sphinx 为我正在创建的包创建一些文档。文档生成正确，但它也会为导入创建文档。是否可以将自动模块配置为只为指定模块(而不是导入模块)中存在的函数创建文档？

编辑

这仅在执行以下导入时发生:from pylab import *

在我的第一个文件中:

.. automodule:: name.subname
   :members:

mzjn 指出这个问题已经有人问过:Documenting files with "from x import *"

答案是改变pylab的导入方式:

import pylab
from pylab import *
for k,v in pylab.__dict__.iteritems():
    if hasattr(v,'__module__'):
        if v.__module__ is None:
            locals()[k].__module__ = 'pylab'

Answer 1

For modules, __all__ will be respected when looking for members; the order of the members will also be the order in __all__.

__all__ 是模块声明其实际希望成为其公共(public) namespace 的好方法。您还可以在 Sphinx 配置中的 :members: 之后放置一个逗号分隔的成员列表，但 __all__ 对导入和其他工具也很有用。