BeeWare Docs Strumenti Sezione demo uno: pagina due¶

Link a piè di pagina e navigazione¶

La navigazione dovrebbe essere visualizzata nella parte inferiore della pagina; "BeeWare Docs Tools Demo Section One" dovrebbe trovarsi a sinistra, mentre "Section Two" dovrebbe trovarsi a destra. Il piè di pagina dovrebbe trovarsi sotto i link di navigazione. Ciò conferma che la configurazione del tema è stata applicata.

Documentazione di riferimento della classe¶

Quanto segue dovrebbe mostrare la documentazione di riferimento per la classe DocsTest, situata in docs_test.py, nella directory src/beeware_docs_tools. Ciò verifica che il collegamento simbolico alla directory del codice sorgente funzioni correttamente.

Verificare che il testo nella tabella dei parametri venga visualizzato con le stesse dimensioni del resto del carattere.

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

Funzionalità macro¶

Il testo seguente dovrebbe essere "Brutus dice 'Ciao mondo!'". Ciò conferma che le variabili globali e le macro definite tramite MkDocs-Macros sono disponibili.

Brutus dice "Hello world!"