mkdocstrings-python-legacy

mkdocstrings的遗留Python处理器。

警告：我们建议使用新处理器：mkdocstrings-python。

安装

您可以将此处理器作为 mkdocstrings 的额外组件安装。

# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
    "mkdocstrings[python-legacy]>=0.18",
]

您还可以明确依赖处理器。

# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
    "mkdocstrings-python-legacy",
]

预览

功能

• 从源代码收集数据： 通过pytkdocs收集对象树和文档字符串。

• 支持类型注解： pytkdocs收集您的类型注解，mkdocstrings使用它们来显示参数类型或返回类型。

• 递归记录Python对象： 仅使用模块点分路径作为标识符，即可获取完整模块文档。您不需要为每个类、函数等注入文档。

• 支持已记录属性： 跟随文档字符串（三引号字符串）的属性（变量）将被Griffe识别，在模块、类甚至__init__方法中。

• 多种文档字符串样式支持：支持Google样式、Numpydoc样式和Sphinx样式的文档字符串。

• 在Google文档字符串中支持警告提示：例如 注意： 或 警告： 的块将被转换为它们的 警告提示 等效。 我们不支持文档字符串中的嵌套警告提示！

• 每个对象都有一个目录条目：我们为每个对象渲染一个标题，这意味着 MkDocs 会将它们纳入目录，Material主题会很好地显示。感谢 mkdocstrings 的交叉引用能力，您可以使用经典的Markdown语法在文档字符串中引用其他对象：[此对象][package.module.object] 或直接使用 [package.module.object][]

• 源代码显示： mkdocstrings 可以添加一个包含Python对象高亮源代码的可折叠div。