Sphinx AutoClass不导入模块
本文介绍了Sphinx AutoClass不导入模块的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!
问题描述
冒着被告知我没有充分研究这一点的风险(我已经在这方面研究了大半个星期),我无法在狮身人面像中使用自动类功能。我收到一系列导入错误。我已将sys.path.insert(0,os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('..'))
添加到conf.py
文件中,因此这不应该是原因,因为我还尝试了一系列其他文件。
我在这里做了一个小示例repo:GitHub
但标题是这样的:
在结构的回购中:
其中text.py
和text2.py
包含如下的简单类:
和text.rst
为:
我不明白为什么它不起作用。显然,我遗漏了一些东西,但我发现狮身人面像的文档(对于文档包来说具有讽刺意味)真的很难效仿,因为它超出了琐碎的范围,而且也不是非常复杂。
如能就问题所在提供任何帮助,我们将不胜感激。
推荐答案
首先,始终粘贴错误堆栈,以减少回答者的工作,如下所示:
这些警告准确地说明了问题所在。第一个:
...表示在text.rst
第6行有一个不正确的导入。因此请更改以下内容:
至此:
第二个警告:
...表示text2.rst
无法"导入类‘笑话’",并继续...
...这意味着在text2.py
中,在第10行的方法定义之后需要更多缩进。因此缩进该方法的return
语句。
一旦您修复了这两个错误,您就应该很好了。
额外提示#1:使用代码编辑器来检查您的Python语法中的简单错误。我喜欢皮查姆。它用各种红色和黄色旗帜标记您的代码。 额外提示2:您的__init__.py
中不需要任何导入语句。可以为空。
这篇关于Sphinx AutoClass不导入模块的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!