使用sphinx-apidoc,使html找不到模块

时间:2018-12-20 14:27:04

标签: python python-sphinx sphinx-apidoc

我正在使用sphinx-apidoc,尽管生成了.rst文件,但运行'make html'时似乎无法解析模块。错误看起来像这样:

extend my_unit {

    run() is also {
        for each line in file "my_text.txt" do {
            // ...
        };
    };
};

我了解问题所在,但不知道如何解决;实际上,MyRootFolder只是添加到sys.path的根目录,并且'mathext'模块是在Python'import mathext'中导入的。

我怀疑apidoc正在采用根路径“ MyRootFolder”并执行“ import MyRootFolder.mathext”。

我的conf.py文件顶部是以下声明:

*** Error: No match for file 'my_text.txt'

文件夹结构如下

WARNING: autodoc: failed to import module u'mathext' from module u'MyRootFolder'; the following exception was raised:
No module named MyRootFolder

这是我正在运行的命令(来自docs文件夹):

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

docs / _modules / MyRootFolder.mathext的结果

MyRootFolder
    docs
        conf.py
        ...
    mathext.py
    another_package
        __init__.py
    third_module.py

编辑: 发现如果我在MyRootFolder下为每个模块/软件包显式运行sphinx-apidoc:

sphinx-apidoc /o ./_modules ../
make html

然后运行“ make help”,我不再遇到此错误。但是,只能对每个软件包执行此操作(仅接受文件夹作为源),而我无法获取“ mathext.py”的文档

0 个答案:

没有答案