构建sphinx文档时导入模块失败

Question

我正在使用Sphinx版本1.4.5.

我的项目结构如下：

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

src即使在添加文件夹路径后docs/conf.py：

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

Answer 1

我喜欢使用以下代码来conf.py准确了解当前目录是什么以及目标模块在哪里（以获取文档）：

\n\n

current_dir = os.path.dirname(__file__)\ntarget_dir = os.path.abspath(os.path.join(current_dir, "../../src"))\nsys.path.insert(0, target_dir)\n\nprint(target_dir)\n

\n\n

在本例中，我希望为我的 src 创建文档，请参阅树以了解上下文：

\n\n

main\n\xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 docs\n\xe2\x94\x82\xc2\xa0\xc2\xa0 \xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 build\n\xe2\x94\x82\xc2\xa0\xc2\xa0 \xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 make.bat\n\xe2\x94\x82\xc2\xa0\xc2\xa0 \xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 Makefile\n\xe2\x94\x82\xc2\xa0\xc2\xa0 \xe2\x94\x94\xe2\x94\x80\xe2\x94\x80 source\n\xe2\x94\x82       \xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 conf.py\n\xe2\x94\x82       \xe2\x94\x94\xe2\x94\x80\xe2\x94\x80 index.rst\n\xe2\x94\x82 \n\xe2\x94\x94\xe2\x94\x80\xe2\x94\x80 src\n    \xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 __init__.py\n    \xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 target_module\n    \xe2\x94\x9c\xe2\x94\x80\xe2\x94\x80 requirements.txt\n    \xe2\x94\x94\xe2\x94\x80\xe2\x94\x80 setup.py\n

\n\n

接下来，从您的终端：

\n\n

[user@localhost docs]$ sphinx-apidoc -f -o source/ ../src/target_module\n[user@localhost docs]$ make html\n

\n

Answer 2

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

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

还要为您的目录考虑一个比src.