使用Monorepo插件时Mkdocstrings报“No module named”错误的解决求助
Monorepo插件时Mkdocstrings报“No module named”错误的解决求助
大家好,我最近在使用Monorepo插件为仓库里的多个包构建嵌套文档,遇到了一个棘手的问题,想向各位请教解决方案:
我的仓库基础结构是这样的:
root ├── mkdocs.yml ├── docs ├── components ├── packages │ └── package1 │ ├── mkdocs.yml │ ├── docs │ │ └── api.md │ └── folder_with_py_files │ └── file.py
Monorepo插件本身功能正常,但当我尝试不安装这些包就构建文档时,mkdocstrings始终找不到对应的模块。我已经在根目录的mkdocs.yml和package1目录下的mkdocs.yml里都配置了path: []字段,但问题依然存在。
在package1/docs/api.md文件中,我是这样引用模块的:
::: folder_with_py_files.file
构建时会抛出以下错误:
ERROR - mkdocstrings: Importing 'folder_with_py_files.file' failed, possible causes are:
- an exception happened while importing
- an element in the path does not exist
...
ERROR - Error reading page 'package1/api.md':
ERROR - Could not collect 'folder_with_py_files.file'
Aborted with a BuildError!
有没有朋友遇到过类似的问题?或者有什么思路可以解决这个不安装包就能让mkdocstrings正确识别模块的问题?
备注:内容来源于stack exchange,提问作者panky_is
相关产品推荐
相关产品推荐

