我正在使用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'
但是一旦我从some_module
中删除了main_script.py
,它就会生成文档。
这是怎么了?
答案 0 :(得分: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
答案 1 :(得分:0)
确保PYTHONPATH env变量包含带有模块的文件夹。看到 pdoc-no-module-named-xxx
答案 2 :(得分:0)
确保将pdoc3安装在单独的虚拟环境中。 为根文件夹示例folderx设置环境变量 导出Folderx的路径后,请使用
pdoc3 --html文件夹x
在名为html的文件夹中生成folderx的pyfile作为文档