BeeWare Docs Tools Демонстрационный раздел 1: страница 2¶

Нижний колонтитул и навигационные ссылки¶

Навигация должна отображаться внизу страницы; «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: `{}`

Макрофункциональность¶

Следующее должно быть «Брут говорит: «Привет, мир!»». Это подтверждает, что глобальные переменные и макросы, определенные с помощью MkDocs-Macros, доступны.

Brutus говорит «Hello world!»