生成Shinx文档时无法导入模块

问题描述

我使用的是Sphinx版本1.4.5。

我的项目结构如下：

+ src > main.py + docs (generated with sphinx-quickstart)

即使将路径添加到docs/conf.py中的src文件夹：

sys.path.insert(0, os.path.abspath('../src'))

并为src/main.py(即docs/src.rst和docs/modules.rst)生成第一个文件：

$ sphinx-apidoc -fo docs src

当我尝试构建html网页时：

$ make clean
$ make html

找不到src模块和src/main.py：

WARNING: autodoc: failed to import module u'src.main'; the following exception was raised

---

解决方案

尝试对您的路径插入执行此操作：

sys.path.insert(0, os.path.abspath('../'))

还要考虑为您的目录指定一个比src更好的名称。