BeeWare 文檔工具示範區段一：第二頁

頁尾與導覽連結

導覽列應顯示於頁面底部；「BeeWare Docs Tools 示範區段一」應置於左側，「區段二」應置於右側。頁尾應位於導覽連結下方。此配置確認主題設定已成功套用。

類別參考文件

以下內容應顯示位於 DocsTest 目錄中 docs_test.py 類別的參考文件。此操作可驗證源代碼目錄的符號連結功能運作正常。

請確認參數表中的文字是否與字型其餘部分以相同大小呈現。

beeware_docs_tools.docs_test.DocsTest

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

This is the test class.

PARAMETER	DESCRIPTION
arg1	A value. TYPE: int
arg2	A value with a default. TYPE: int DEFAULT: 42
kwargs	keyword arguments DEFAULT: {}

attribute property

attribute: int

This is a test attribute.

method

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

This is a test method.

PARAMETER	DESCRIPTION
arg1	A value. TYPE: int
arg2	A value with a default. TYPE: int DEFAULT: 42
kwargs	keyword arguments DEFAULT: {}

巨集功能

以下內容應顯示「Brutus 說『Hello world！』」。這確認了透過 MkDocs-Macros 定義的全局變數和巨集可正常使用。

Brutus 說「Hello world!」