python - Sphinx autodoc 因第三方包的 ImportError 而死掉

Question

有什么方法可以排除模块的导入部分，然后用 sphinx-python 记录它？我有一个模块导入另一个包(其他不同的项目)，然后 sphinx 给出此错误:

""" File "/usr/local/lib/python2.7/dist-packages/Sphinx-1.1.3-py2.7.egg/sphinx/ext/autodoc.py", line 321, in import_object import(self.modname) File "/home/x/GitHub/project/mod_example1.py", line 33, in from other_pck import Klass, KlassStuff ImportError: No module named other_pck """

如果我注释模块中调用/导入打包 sphinx 的导入部分，则可以执行 autodoc。我尝试了所有 sphinx autodoc 模块:autoclass、automodule 等...但一旦尝试导入其他包，结果总是相同的。

谢谢

Answer 1

您解决问题的方式是错误的。解决此问题的正确方法是让 Sphinx 知道您现有的其他包，因为 autodoc 功能必须导入 Python 包才能扫描源代码。如果没有解决所有依赖项，则无法导入 Python 包，并且您无法从中挑选源代码行，因为这就是 Python 的构建方式(*)

可能的解决方案是

• 创建 Sphinx 和其他包所在的 Python virtualenv 环境，以便它们可以互相看到 http://opensourcehacker.com/2012/09/16/recommended-way-for-sudo-free-installation-of-python-software-with-virtualenv/

• 设置 PYTHONPATH 环境变量或编辑 Sphinx 配置文件中的 sys.path，以便在运行 Sphinx 时将缺少的包添加到导入列表中 http://scienceoss.com/minimal-sphinx-setup-for-autodocumenting-python-modules/

*)理论上可以，但这超出了 Sphinx 和这个问题的范围