跳转至

BeeWare 文档工具演示部分一:第二页

页脚和导航链接

导航栏应显示在页面底部;"BeeWare 文档工具演示第一部分"应位于左侧,"第二部分"应位于右侧。页脚应置于导航链接下方。这表明主题配置已成功应用。

类参考文档

以下内容应显示位于DocsTest目录中docs_test.py类的参考文档。这可验证源代码目录的符号链接功能是否正常。

请确认参数表中的文本渲染尺寸与字体其他部分一致。

beeware_docs_tools.docs_test.DocsTest

DocsTest(arg1: int, arg2: int = 42, **kwargs)

This is the test class.

参数 描述
arg1

A value.

类型: int

arg2

A value with a default.

类型: int 默认: 42

kwargs

keyword arguments

默认: {}

attribute property

attribute: int

This is a test attribute.

method

method(arg1: int, arg2: int = 42, **kwargs)

This is a test method.

参数 描述
arg1

A value.

类型: int

arg2

A value with a default.

类型: int 默认: 42

kwargs

keyword arguments

默认: {}

宏功能

以下内容应显示为“Brutus says 'Hello world!'”。这证实了通过 MkDocs-Macros 定义的全局变量和宏是可用的。

Brutus 说 "Hello world!"