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 作為文檔