跳到主要内容

特殊类型及对应页面列表

以下是目前支持的数据类型。不同类型的数据将会按照类型、渲染成具有对应样式的文档页面。速览以下范例页面，将能帮助读者快速了解 pyDocusaurus 如何运作。

提示

本站点的所有 API 文档均生成自 pyDocusaurus。以下列表展示了各种 Python 数据类型对应的文档页面代表性范例。其内容展示了当前版本的实际运行效果。

1. 模块

类型	pyDocusaurus 数据	对应页面渲染范例
`package`	`DocModule`	`core`
`module`	`DocModule`	`core.modules`

2. 函数和属性

类型	pyDocusaurus 数据	对应页面渲染范例
`function`	`DocFunction`	`parse_argument_docs`
`function` （迭代器）	`DocFunction`	`get_members_defined_in_class`
`method`	`DocFunction`	`Components.get_headers`
`classmethod`	`DocFunction`	`ClassProfile.from_class`
`staticmethod`	`DocFunction`	`PackageWalker.get_member_type`
`property`	`DocProp`	`Components.apibar`
`operator`	`DocOpTemplate`	`dfc.caches.lrudict.LRUDict.__getitem__`

3. 类

类型	pyDocusaurus 数据	对应页面渲染范例
`class`	`DocClass`	`Components` `dfc.caches.lrudict.LRUDict`
`abc.ABC`	`DocClass`	`SaverAbstract`
`dataclass` 或`pydantic.BaseModel`	`DocDataClass`	`ClassProfile` `RendererPage`
`enum`	`DocEnum`	`FunctionType`

4. 类型

类型	pyDocusaurus 数据	对应页面渲染范例
`typealias`	`DocTypeAlias`	`dfc.caches.typehints.Deferred`
`typedict`	`DocTypedDict`	`dfc.caches.typehints.CachedFileInfo`
`protocol`	`DocProtocol`	`ProtocolComponent`

1. 模块
2. 函数和属性
3. 类
4. 类型