BeeWare Docs Tools Demo část první: strana druhá¶

Patička a navigační odkazy¶

Navigace by se měla zobrazit v dolní části stránky; „BeeWare Docs Tools Demo Section One“ by mělo být vlevo, „Section Two“ vpravo. Zápatí by mělo být pod navigačními odkazy. Tím se potvrzuje, že konfigurace motivu byla použita.

Referenční dokumentace třídy¶

Následující příkaz by měl zobrazit referenční dokumentaci pro třídu DocsTest, která se nachází v docs_test.py, v adresáři src/beeware_docs_tools. Tím se ověří, že symlinkování adresáře se zdrojovým kódem funguje správně.

Ověřte, zda se text v tabulce parametrů vykresluje ve stejné velikosti jako zbytek písma.

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 funkce¶

Následující text by měl znít „Brutus říká ‚Ahoj světe!‘“. Tím se potvrzuje, že globální proměnné a makra definovaná pomocí MkDocs-Macros jsou k dispozici.

Brutus říká „Hello world!“