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

Failed to import module when building the sphinx documentation(生成Shinx文档时无法导入模块)
本文介绍了生成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.rstdocs/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更好的名称。

这篇关于生成Shinx文档时无法导入模块的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Leetcode 234: Palindrome LinkedList(Leetcode 234:回文链接列表)
How do I read an Excel file directly from Dropbox#39;s API using pandas.read_excel()?(如何使用PANDAS.READ_EXCEL()直接从Dropbox的API读取Excel文件?)
subprocess.Popen tries to write to nonexistent pipe(子进程。打开尝试写入不存在的管道)
I want to realize Popen-code from Windows to Linux:(我想实现从Windows到Linux的POpen-code:)
Reading stdout from a subprocess in real time(实时读取子进程中的标准输出)
How to call type safely on a random file in Python?(如何在Python中安全地调用随机文件上的类型?)