BeeWare Docs Tools - Phần trình diễn 1: Trang 2¶

Chân trang và các liên kết điều hướng¶

Thanh điều hướng phải hiển thị ở cuối trang; phần "BeeWare Docs Tools Demo Section One" phải nằm bên trái, phần "Section Two" phải nằm bên phải. Phần chân trang phải nằm dưới các liên kết điều hướng. Điều này xác nhận rằng cấu hình chủ đề đã được áp dụng.

Tài liệu tham khảo về lớp¶

Phần sau đây sẽ hiển thị tài liệu tham khảo cho lớp DocsTest, nằm trong thư mục docs_test.py, thuộc thư mục src/beeware_docs_tools. Điều này giúp xác minh rằng liên kết tượng trưng của thư mục mã nguồn đang hoạt động bình thường.

Kiểm tra xem văn bản trong bảng tham số có được hiển thị với kích thước tương tự như phần còn lại của phông chữ hay không.

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: `{}`

Chức năng macro¶

Đoạn mã sau đây sẽ hiển thị dòng chữ 'Brutus says "Hello world!"'. Điều này xác nhận rằng các biến toàn cục và macro được định nghĩa thông qua MkDocs-Macros đã sẵn sàng sử dụng.

Brutus nói: "Hello world!"