BeeWare Docs Tools Demo afsnit et: side to

Fodnote og navigationslinks

Navigationen skal vises nederst på siden; "BeeWare Docs Tools Demo Section One" skal være til venstre, "Section Two" skal være til højre. Fodnoten skal være under navigationslinkene. Dette bekræfter, at temakonfigurationen er blevet anvendt.

Klassehenvisningsdokumentation

Følgende skal vise referencedokumentationen for klassen DocsTest, der findes i docs_test.py, i mappen src/beeware_docs_tools. Dette bekræfter, at symlinking af kildekodemappen fungerer korrekt.

Kontroller, at teksten i parametertabellen vises i samme størrelse som resten af skrifttypen.

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

Makrofunktionalitet

Følgende skal sige 'Brutus siger "Hej verden!"'. Dette bekræfter, at globale variabler og makroer defineret via MkDocs-Macros er tilgængelige.

Brutus siger "Hello world!"