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

Question

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

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

.. 其中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'

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

这里有什么问题？

Answer 1

我有个类似的问题。

我的文件夹结构与原始问题的结构相似，但有额外的脚本文件夹。 在每个文件夹中运行pdoc script_name.py ，一些文件给了我错误

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

我能够通过确保所有路线正确并出于某种原因更改导入顺序来解决这些问题。 尝试先导入所有文件，然后再导入其他文件（例如 numpy、pandas 等）

我无法解决的一件事是，虽然我可以为所有单个文件生成文档，但其中一个（并且只有一个）文件夹仍然给我错误

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

Answer 2

确保 PYTHONPATH 环境变量包含模块所在的文件夹。 请参阅pdoc-no-module-named-xxx

Answer 3

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

pdoc3 --html 文件夹x

在名为 html 的文件夹中生成 folderx 的 pyfiles 作为文档