BeeWare Docs Tools Sekcja demonstracyjna pierwsza: strona druga¶

Stopka i linki nawigacyjne¶

Nawigacja powinna wyświetlać się na dole strony; „BeeWare Docs Tools Demo Section One” powinno znajdować się po lewej stronie, a „Section Two” po prawej. Stopka powinna znajdować się poniżej linków nawigacyjnych. Potwierdza to, że konfiguracja motywu została zastosowana.

Dokumentacja referencyjna klasy¶

Poniżej powinna pojawić się dokumentacja referencyjna klasy DocsTest, znajdująca się w katalogu docs_test.py, w katalogu src/beeware_docs_tools. Potwierdza to, że dowiązania symboliczne katalogów z kodem źródłowym działają poprawnie.

Sprawdź, czy tekst w tabeli parametrów jest renderowany w tym samym rozmiarze, co reszta czcionki.

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

Funkcjonalność makr¶

Poniższy fragment powinien brzmieć „Brutus mówi »Witaj świecie!«”. Potwierdza to, że zmienne globalne i makra zdefiniowane za pomocą MkDocs-Macros są dostępne.

Brutus mówi „Hello world!”