Sphinx无法找到模块,但Python可以

时间:2017-01-29 21:08:33

标签: python module documentation package python-sphinx

Python文档生成器Sphinx似乎不了解我的模块/包。在make clean && make html上运行此代码后,它会输出ImportError: No module named 'statstuff'from statstuff import statistics as stats

我还尝试将模块引用为from . import statistics as stats,因为模块位于同一个包中,但Sphinx输出SystemError: Parent module '' not loaded, cannot perform relative import

此外,config.py似乎已正确配置为sys.path.insert(0, os.path.abspath('../statstuff/')),因为文档文件夹与statstuff文件夹共享其父文件夹。

无论如何,这里是包含文件的存储库:https://github.com/lucasmauro/statstuff

问题出现在statstuff/regression.py第2行和第3行:https://github.com/lucasmauro/statstuff/blob/master/statstuff/regression.py

代码使用Python解释器正常运行,但是Sphinx在编写代码(或配置)时无法找到模块。

有没有人知道如何解决这个问题?

非常感谢你!

1 个答案:

答案 0 :(得分:2)

由于您的模块位于名为statstuff的{​​{3}}中,我建议如下:

  1. 在conf.py中将上面的目录 statstuff的路径添加到sys.path

    sys.path.insert(0, os.path.abspath('..'))
    
  2. 编辑automodule指令。改变

    .. automodule:: probability 
    

    .. automodule:: statstuff.probability
    

    等等。