使用mkdocstrings自动生成Python包全模块API文档失败求助

• 检查包的__init__.py配置
  mkdocstrings默认只渲染包__init__.py里显式导出的内容。如果你的mypackage/__init__.py是空的，或者没导入子模块，插件没法识别包下的子模块，自然渲染空白。你需要在__init__.py里导入子模块，或者用__all__声明要导出的模块：

  # mypackage/__init__.py
  from . import module1, module2
  __all__ = ["module1", "module2"]
  

• 调整mkdocstrings的渲染选项
  在mkdocs.yml里给mkdocstrings添加递归渲染的配置，让插件自动遍历包下所有子模块：

  plugins:
    - mkdocstrings:
        handlers:
          python:
            options:
              members: true
              show_submodules: true
              recursive: true
  

  其中show_submodules控制是否显示子模块入口，recursive控制是否递归渲染子模块的内部内容。

• 确认包的可导入路径
  虽然日志显示已加载源码，但要确保mypackage在Python的可导入路径中。如果你的源码放在src目录下，可以在mkdocs.yml里添加：

  extra_paths:
    - src
  

内容的提问来源于stack exchange，提问作者Vince