BeeWare Docs Tools Demo Abschnitt eins: Seite zwei¶

Fußzeile und Navigationslinks¶

Die Navigation sollte am unteren Rand der Seite dargestellt werden; "BeeWare Docs Tools Demo Section One" sollte auf der linken Seite, "Section Two" sollte auf der rechten Seite stehen. Die Fußzeile sollte sich unter den Navigationslinks befinden. Dies bestätigt, dass die Themenkonfiguration angewendet wurde.

Klassenreferenzdokumentation¶

Das Folgende sollte die Referenzdokumentation für die Klasse DocsTest anzeigen, die sich in docs_test.py im Verzeichnis src/beeware_docs_tools befindet. Damit wird überprüft, ob das Symlinking des Quellcode-Verzeichnisses richtig funktioniert.

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

Makro-Funktionalität¶

Im Folgenden sollte 'Brutus sagt "Hallo Welt!"' stehen. Dies bestätigt, dass globale Variablen und Makros, die über MkDocs-Macros definiert wurden, verfügbar sind.

Brutus sagt "Hello world!"