BeeWare Docs Tools Demostración sección uno: página dos¶

Enlaces de pie de página y navegación¶

La navegación debe aparecer en la parte inferior de la página; «BeeWare Docs Tools Demo Section One» debe estar a la izquierda y «Section Two» a la derecha. El pie de página debe estar debajo de los enlaces de navegación. Esto confirma que se ha aplicado la configuración del tema.

Documentación de referencia de clases¶

Lo siguiente debería mostrar la documentación de referencia para la clase DocsTest, ubicada en docs_test.py, en el directorio src/beeware_docs_tools. Esto verifica que el enlace simbólico del directorio del código fuente funciona correctamente.

Comprueba que el texto de la tabla de parámetros se muestra con el mismo tamaño que el resto de la fuente.

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

Funcionalidad macro¶

Lo siguiente debería decir «Brutus dice "¡Hola mundo!"». Esto confirma que las variables globales y las macros definidas a través de MkDocs-Macros están disponibles.

Brutus dice «Hello world!».