python – Sphinx：导入错误而不是文档包.有没有办法“跳过”？

2019-05-30 00:52:29 阅读：316 来源： 互联网

标签：python documentation python-sphinx importerror

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

我创建了一个samplecode.rst,我将尝试组织(并自动生成)我的一个类(MyClass.py)的文档.

这是该samplecode.rst的一部分：

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

但是当我尝试执行make html时,我得到一个导入错误并且没有导入’MyClass'(在生成的.html中显示’MyClass’的空条目)：

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)

那个弄乱我生活的东西是一个安装在$HOME / .buildout / eggs /中的模块,我还没有创建,也不需要记录.

我已经将$HOME / .buildout / eggs /中发现的所有鸡蛋添加到Pythonpath(在Sphinx的conf.py文件中)但是没有修复任何东西所以现在我正在尝试不同的方法(放弃)所以这里问题是：我可以做些什么来跳过这种错误吗？

我只想在/home/borrajax/Projects/myProject/backlib/classes/MyClass.py中的注释显示在一个漂亮的html页面中,就是这样.

先感谢您

解决方法:

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

尝试在sp.x的conf.py中添加以下内容.

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

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

标签：python,documentation,python-sphinx,importerror
来源： https://codeday.me/bug/20190530/1182115.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

python – Sphinx：导入错误而不是文档包.有没有办法“跳过”？