BeeWare Docs Tools Demo section one : page two¶

La navigation doit s'effectuer au bas de la page ; "BeeWare Docs Tools Demo Section One" doit se trouver à gauche, "Section Two" à droite. Le pied de page doit se trouver sous les liens de navigation. Cela confirme que la configuration du thème a été appliquée.

Documentation de référence des classes¶

Ce qui suit devrait afficher la documentation de référence pour la classe DocsTest, située dans docs_test.py, dans le répertoire src/beeware_docs_tools. Cela permet de vérifier que le lien symbolique vers le répertoire du code source fonctionne correctement.

Vérifiez que le texte dans le tableau des paramètres s'affiche dans la même taille que le reste de la police.

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

Fonctionnalité des macros¶

Ce qui suit devrait être "Brutus dit "Hello world !"". Cela confirme que les variables globales et les macros définies via MkDocs-Macros sont disponibles.

Brutus dit "Hello world!"