Skip to main content
 首页 » 编程设计

python之Sphinx 将 NumPy 模块的文档添加到我的文档中

2025年05月04日12cloudgamer

我想为我的 Python 代码生成 Sphinx 文档。此代码从 numpy 进行一些导入。我在 mycode 上使用 sphinx-apidoc,然后运行 ​​make html。它生成文档,但它还包含 numpy 中的 uniform 函数的文档。如何禁用此类冗余包含?

这是我的代码:

# encoding: utf-8 
""" 
This module does blah blah. 
""" 
 
from numpy.random import uniform  #WHY IS IT INCLUDED IN SPHINX DOC?!!!! 
 
class UberMegaClass(object): 
    """Hell yeah!""" 
    def __init__(self, num_of_something): 
        print("---") 
        self.num_of_something = num_of_something 

请您参考如下方法:

这是 Sphinx 处理 C++ 扩展的一个已知错误;他们可以 不必要地包含在文档中。有一个半官方的 workaround建议您将这些模块替换为 Mock 对象 在你的 conf.py 中,像这样:

import sys 
 
class Mock(object): 
 
    __all__ = [] 
 
    def __init__(self, *args, **kwargs): 
        pass 
 
    def __call__(self, *args, **kwargs): 
        return Mock() 
 
    @classmethod 
    def __getattr__(cls, name): 
        if name in ('__file__', '__path__'): 
            return '/dev/null' 
        elif name[0] == name[0].upper(): 
            mockType = type(name, (), {}) 
            mockType.__module__ = __name__ 
            return mockType 
        else: 
            return Mock() 
 
MOCK_MODULES = ['pygtk', 'gtk', 'gobject', 'argparse', 
                'numpy', 'numpy.random'] 
for mod_name in MOCK_MODULES: 
    sys.modules[mod_name] = Mock()