mkdocstrings的Python处理程序。
项目描述
mkdocstrings-python
mkdocstrings的Python处理程序。
Python处理程序使用Griffe从Python源代码中收集文档。在法语中，“griffe”有时可以用来代替“signature”。Griffe能够访问源代码的抽象语法树（AST）以提取有用信息。它还可以在源代码不可用的情况下执行代码（通过导入）并检查内存中的对象。最后，它可以解析不同风格的文档字符串。
安装
您可以将此处理程序作为mkdocstrings扩展安装。
# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
"mkdocstrings[python]>=0.18",
]
您也可以明确依赖处理程序。
# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
"mkdocstrings-python",
]
预览
功能
-
从源代码收集数据：通过Griffe收集对象树和文档字符串。
-
对类型注解的支持： Griffe 会收集您的类型注解，并使用 mkdocstrings 来显示参数类型或返回类型。它甚至能够自动将来自您的 API、标准库或第三方库的其他对象添加为交叉引用！请参阅如何加载清单以启用此功能。
-
Python 对象的递归文档：只需使用模块点路径作为标识符，即可获得完整的模块文档。您无需为每个类、函数等注入文档。
-
对已记录属性的支持：在模块、类甚至
__init__方法中，Griffe 会识别出跟有文档字符串（三引号字符串）的属性（变量）。 -
多种文档字符串风格支持：支持 Google-style、Numpydoc-style 和 Sphinx-style 文档字符串。请参阅 Griffe 的文档字符串支持。
-
Google 文档字符串中的注意支持：类似于
注意：或警告：的块将被转换为它们的注意等效物。我们不支持在文档字符串中嵌套注意！ -
每个对象都有一个目录条目：我们为每个对象渲染一个标题，这意味着 MkDocs 会将它们纳入目录中，并由 Material 主题优雅地显示。感谢 mkdocstrings 的交叉引用能力，您可以在文档字符串中使用经典的 Markdown 语法引用其他对象：
[此对象][包.模块.对象]或直接使用[包.模块.对象][] -
源代码显示： mkdocstrings 可以添加一个包含突出显示的 Python 对象源代码的可折叠 div。
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源代码发行版
构建发行版
mkdocstrings_python-1.11.1.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 8824b115c5359304ab0b5378a91f6202324a849e1da907a3485b59208b797322 |
|
| MD5 | a3c7fd23eb7290e381d8d516ce043613 |
|
| BLAKE2b-256 | fcba534c934cd0a809f51c91332d6ed278782ee4126b8ba8db02c2003f162b47 |
mkdocstrings_python-1.11.1-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | a21a1c05acef129a618517bb5aae3e33114f569b11588b1e7af3e9d4061a71af |
|
| MD5 | 8b1cc5cfe10e8a22e7d6a926e24d2dd2 |
|
| BLAKE2b-256 | 2ff22a2c48fda645ac6bbe73bcc974587a579092b6868e6ff8bc6d177f4db38a |
