Saltar a contenido

Demostración de herramientas de Docs

Lista de verificación del tema

Esta demostración está diseñada para probar las diversas características de las modificaciones del tema BeeWare MkDocs Material. Lea detenidamente y compruebe que todo lo que aparece en esta página y en las siguientes está presente y funciona tal y como se detalla en la descripción.

Barra de título

Hay una barra de título gris medio en la página. Se ha aplicado la plantilla del tema.

Icono de encabezado

Se ha renderizado el icono del encabezado situado en la parte superior izquierda. Esto confirma que la plantilla puede hacer referencia a recursos externos.

Icono de la barra lateral de la página de inicio

Se ha renderizado el icono del logotipo en la barra lateral izquierda. El logotipo debe tener el mismo ancho y la misma altura que la barra lateral. El título del sitio debe aparecer debajo, con una fuente ligeramente más grande que el resto de la barra lateral, y el número de versión debajo, con una fuente más pequeña.

Esto confirma que la barra lateral se mostrará correctamente en los sitios de destino.

Fuente del título

Los encabezados se muestran en Cutive. Esto confirma que se ha aplicado el tema CSS personalizado de BeeWare.

Código en línea

El código en línea se muestra con el mismo color que la fuente circundante. Esto confirma que el tema no ha provocado ningún cambio indeseado.

Este es un texto con inline code aquí y inline code aquí.

Código de contenido con pestañas

El código aparece en un color que contrasta con el fondo. El botón Copiar solo debe copiar los comandos; no debe incluirse el indicador.

Esto confirma que el tema no ha provocado ningún cambio indeseado, así como que el botón de copiar funciona según lo previsto.

$ git clone https://github.com/beeware/beeware-theme.git
$ git clone https://github.com/beeware/beeware-theme.git
C:\...>git clone https://github.com/beeware/beeware-theme.git

Comportamiento del botón Copiar código

El botón Copiar del siguiente bloque de código debería copiar from pathlib import Path al portapapeles.

from pathlib import Path

El botón Copiar del siguiente bloque de código debería copiar ls beeware-docs-tools al portapapeles. No se deben incluir el indicador del shell ni la salida.

(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt  tox.ini
docs pyproject.toml    requirements.docs.txt
LICENSE README.md    src

Enlaces de la barra lateral

Existen enlaces en la barra lateral que apuntan al repositorio beeware-docs-tools. Esto confirma que se ha cargado el contenido de la barra lateral, que se ha configurado project-name en el archivo de configuración de MkDocs y que se ha calculado y añadido el número de versión.

Colores de los enlaces

Este enlace a la página web principal de BeeWare debería aparecer en azul tanto en el modo claro como en el modo oscuro.

Los enlaces de las barras laterales izquierda y derecha también deben ser azules en ambos modos.

Al desplazarse hacia abajo en la página, el enlace activo del encabezado en la barra lateral derecha debe ser de color azul claro en el modo oscuro y azul más oscuro en el modo claro.

Advertencia sobre la traducción

La versión en inglés de este documento debe mostrar la advertencia «Hay traducciones disponibles» que aparece a continuación. La traducción al francés debe mostrar la advertencia «¡Esta es una traducción automática!». La traducción al alemán debe mostrar la advertencia «¡Esta es una traducción!» para las traducciones realizadas por personas.

¡Esto es una traducción automática!

Esta versión del tutorial ha sido generada mediante traducción automática. Sabemos que no es lo ideal, pero consideramos que una traducción deficiente es mejor que ninguna traducción.

Página 404 personalizada

Añade nopage al final de la URL en tu navegador para verificar que la página 404 existe e incluye el texto «Brutus no puede encontrar lo que estás buscando». La página 404 actual no siempre muestra las imágenes debido a un problema con MkDocs.

MkDocs falla al compilar enlaces internos no reconocidos, por lo que es necesario verificar manualmente esta comprobación modificando la URL en el navegador.

Próximas comprobaciones

El siguiente enlace le llevará a la sección uno de la demostración de herramientas de BeeWare Docs. Se incluye para verificar los enlaces entre páginas.

Navega a BeeWare Docs Tools Demo Section One para las siguientes comprobaciones.