本文介绍了生成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
更好的名称。
这篇关于生成Shinx文档时无法导入模块的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!
本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!