python - Sphinx : Import error in not to document package. 有没有办法到 "skip"？

Question

我正在尝试开始使用 Sphinx 记录一个小型 Python 项目。

我创建了一个 samplecode.rst，我会尝试在其中组织(并自动生成)我的一个类 (MyClass.py) 的文档。

这是 samplecode.rst 的一部分:

MyClass.py
----------------------------------
.. autoclass:: backlib.classes.MyClass
   :members:

但是当我尝试执行 make html 时，出现导入错误并且未导入“MyClass”(显示“MyClass”的空条目' 在生成的 .html 中):

Traceback (most recent call last):de                                                                                                                                                                                
  File "/usr/lib/pymodules/python2.7/sphinx/ext/autodoc.py", line 329, in import_object
    __import__(self.modname)
  File "/home/borrajax/Projects/myProject/backlib/classes/MyClass.py", line 4, in <module>
    from backlib.database import BaseClass
[ ... ]
    from grokcore.component import sort_components
ImportError: cannot import name sort_components

...稍后...

/home/borrajax/Projects/myProject/docs/source/samplecode.rst:16: (WARNING/2) autodoc can't import/find module 'backlib.classes.MyClass', it reported error: "cannot import name sort_components", please check your spelling and sys.path

/home/borrajax/Projects/myProject/docs/source/samplecode.rst:19: (WARNING/2) don't know which module to import for autodocumenting u'MyClass' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)

grokcore 是一个安装在 $HOME/.buildout/eggs/ 中的模块，我既没有创建也没有创建我需要记录。

我已将在 $HOME/.buildout/eggs/ 中找到的所有 eggs 添加到 Pythonpath(在 Sphinx 的 conf.py 文件中)，但这并没有解决任何问题，所以现在我正在尝试一种不同的方法(放弃)，所以问题来了:我可以做些什么来跳过这种错误吗？

我只是想让 /home/borrajax/Projects/myProject/backlib/classes/MyClass.py 中的注释显示在漂亮的 html 页面中，仅此而已。

Answer 1

我假设您的 sphinx conf.py 中的 sys.path 不包括您的源代码所在的目录。

尝试将以下内容添加到您的 conf.py for sphinx。

sys.path.insert(0, '/home/borrajax/Projects/myProject/')

另外，我假设 backlib 和 backlib/classes 是有效的包(它们包含 __init__.py 文件)。