pdoc3- ValueError:找不到文件或模块

Question

我正在使用pdoc为我的一个项目生成文档。这是我的档案结构-

my_project
|- files
|- logs
|- scripts
   |- __init__.py
   |- main_script.py
   |- script_one.py

..where，main_script.py导入script_one.py和其他几个库。__init__.py是空的。

在my_project/目录中，我运行pdoc3 --html scripts并面临以下错误-

ValueError: File or module 'scripts.main_script' not found

。。。

我运行pdoc3 --html scripts/main_script.py并面临以下错误-

ImportError: Error importing 'scripts/script_one.py': No module named 'random_module'

。。。

在scripts/目录中，当我运行pdoc3 --html main_script.py时，它会抛出一个导入错误，例如-

ImportError: Error importing 'main_script.py': No module named 'some_module'

但是，一旦我从我的some_module中删除main_script.py，它就会生成文档。

这里怎么了？

Answer 1

我也有类似的问题。

我的文件夹结构类似于最初的问题，但有额外的脚本文件夹。在这些文件夹中运行pdoc script_name.py时，有些文件给了我错误

ImportError: Error importing 'module_name.py': No module named 'module_name'

我能够通过确保所有的路线都是正确的，并且，由于某种原因，改变进口顺序来修正这些问题。试着先导入所有的文件，然后再导入其余的文件(如numpy，熊猫，.)

有一件事我还没能解决，那就是，尽管我可以为所有单独的文件生成文档，但只有一个文件夹仍然给出了错误。

ValueError: File or module 'script_folder..module_name' not found

Answer 2

确保PYTHONPATH env变量包含带有模块的文件夹。请参阅pdoc-no-module-named-xxx

Answer 3

确保pdoc3安装在单独的虚拟环境中。导出文件夹路径后，为根文件夹示例folderx设置环境变量

pdoc3 --html文件夹

将folderx的pyfile生成为名为html的文件夹中的文档