BeeWare Docs Tools. Демо. Розділ перший: сторінка друга¶

Нижній колонтитул та посилання навігації¶

Навігація має відображатися внизу сторінки; розділ «BeeWare Docs Tools Demo Section One» має бути зліва, а «Section Two» — справа. Нижній колонтитул має розташовуватися під посиланнями навігації. Це підтверджує, що налаштування теми було застосовано.

Довідкова документація по класах¶

Нижче має бути наведено довідкову документацію для класу DocsTest, що знаходиться в docs_test.py, у каталозі src/beeware_docs_tools. Це дозволяє перевірити, чи правильно працює створення символьних посилань на каталог з вихідним кодом.

Переконайтеся, що текст у таблиці параметрів відображається тим самим розміром, що й решта тексту.

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 says "Hello world!"». Це підтверджує, що глобальні змінні та макроси, визначені за допомогою MkDocs-Macros, доступні.

Brutus каже: «Hello world!»