从源自动生成MkDocs的文档。
项目描述
mkdocstrings
从源自动生成MkDocs的文档。欢迎在MkDocs的Gitter频道进行讨论或提问。
特性
-
语言无关性：与MkDocs一样，mkdocstrings是用Python编写的，但具有语言无关性。这意味着只要有一个处理器，你就可以使用它与任何编程语言一起使用。目前，我们有针对C、Crystal、Python、TypeScript和VBA语言的处理器，以及针对shell脚本/库的处理器。也许你想将其添加到列表中？:wink
-
支持多种主题：每个处理器可以提供多个主题。目前，我们提供Material主题，以及针对Python处理器的ReadTheDocs和MkDocs主题的基本支持。
-
跨页面引用：mkdocstrings允许使用经典的Markdown链接语法（
[identifier][]或[title][identifier]）引用其他Markdown文件中的标题，而你无需记住该对象确切所在的页面。这适用于任何由mkdocstrings语言处理器生成的标题，你也可以选择将任何Markdown标题纳入全局引用方案。注意：在0.15版本之前的版本中，所有Markdown标题都包括在内，但现在你需要启用。
-
跨站点引用：类似于Sphinx的intersphinx扩展，如果其他库提供了清单并且你在MkDocs配置中加载了该清单，则mkdocstrings可以引用其他库的API项。
-
Markdown中的内联注入：与生成Markdown文件不同，mkdocstrings允许你在Markdown内容中的任何地方注入文档。语法很简单：在
:::之后跟着一个缩进4个空格的YAML块。标识符和YAML配置将被传递给适当的处理器以收集和渲染文档。 -
全局和局部配置：每个处理器都可以在
mkdocs.yml中进行全局配置，并且对于每个“autodoc”指令都可以进行局部配置。 -
合理的默认值：你应该能够只需将插件放入配置中，就可以享受自动生成的文档。
使用情况
mkdocstrings被知名公司、项目和科研团队所使用：Ansible、Apache、FastAPI、Google、Jitsi、Microsoft、Prefect、Pydantic、等等...
安装
mkdocstrings包不提供对任何语言的支持：它只是语言处理器的通用基础。这意味着你很可能希望使用一个或多个官方处理器通过附加组件来安装它。例如，要安装具有Python支持的版本
pip install 'mkdocstrings[python]'
或者，您可以直接安装语言处理器本身，这些处理器无论如何都依赖于 mkdocstrings
pip install mkdocstrings-python
这将使您能够更好地控制处理器本身的版本范围。
请参阅官方语言处理器。
使用 conda
conda install -c conda-forge mkdocstrings mkdocstrings-python
快速使用
在 mkdocs.yml 中
site_name: "My Library"
theme:
name: "material"
plugins:
- search
- mkdocstrings
在您的 markdown 文件之一中
# Reference
::: my_library.my_module.my_class
有关更多示例，请参阅文档中的使用部分！
下载文件
下载您平台上的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
