Démonstration des outils BeeWare Docs¶
Liste de contrôle des thèmes¶
Cette démo est conçue pour tester les différentes caractéristiques des surcharges du thème MkDocs Material de BeeWare. Veuillez lire et vérifier que tout ce qui est listé sur cette page et les suivantes est présent et fonctionne comme indiqué dans la description.
Barre de titre¶
Une barre de titre gris moyen est présente sur la page. C'est le modèle de thème qui a été appliqué.
Icône d'en-tête¶
L'icône d'en-tête en haut à gauche a été rendue. Cela confirme que le modèle peut faire référence à des ressources externes.
Icône de la barre latérale de la page d'accueil¶
L'icône du logo dans la barre latérale gauche a été rendue. Le logo doit avoir la même largeur et la même hauteur que la barre latérale. Le titre du site doit être affiché en dessous, dans une police légèrement plus grande que le reste de la barre latérale, et le numéro de version doit être affiché en dessous, dans une police plus petite.
Cela confirme que la barre latérale s'affichera correctement sur les sites cibles.
Police des titres¶
Les titres sont rendus en Cutive. Cela confirme que le thème CSS personnalisé BeeWare a été appliqué.
Inline code¶
Le code en ligne est rendu dans la même couleur que la police environnante. Cela confirme que le thème n'a pas provoqué de changements indésirables.
Il s'agit d'un texte avec code en ligne ici et code en ligne ici.
Code pour le contenu des onglets¶
Le code est d'une couleur contrastante par rapport à l'arrière-plan. Le bouton Copier ne doit copier que les commandes ; l'invite ne doit pas être incluse.
Cela permet de confirmer que le thème n'a pas entraîné de modifications indésirables et que le bouton de copie fonctionne comme prévu.
$ 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
Comportement du bouton de copie de code¶
Le bouton copy sur le bloc de code suivant devrait permettre de copier from
pathlib import Path dans le presse-papiers.
from pathlib import Path
Le bouton copy sur le bloc de code suivant doit permettre de copier ls
beeware-docs-tools dans le presse-papiers. L'invite de l'interpréteur de
commandes et la sortie ne doivent pas être incluses.
(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt tox.ini
docs pyproject.toml requirements.docs.txt
LICENSE README.md src
Liens dans la barre latérale¶
Les liens sidebar existent, et pointent vers le repo beeware-docs-tools. Cela
confirme que le contenu de la barre latérale a été chargé, que le project-name
a été défini dans le fichier de configuration de MkDocs, et que le numéro de
version est calculé et ajouté.
Couleurs des liens¶
Ce lien vers le site web principal de BeeWare devrait être bleu aussi bien en mode clair qu'en mode foncé.
Les liens dans les barres latérales gauche et droite doivent également être bleus dans les deux modes.
Lors du défilement de la page, le lien de l'en-tête actif dans la barre latérale droite doit être bleu clair en mode foncé et bleu plus foncé en mode clair.
Traduction admonition¶
La version anglaise de ce document devrait afficher l'avertissement "Translations are available" ci-dessous. La traduction française doit afficher l'avertissement "Ceci est une traduction automatique". La traduction allemande doit afficher l'avertissement "Ceci est une traduction" pour les traductions humaines.
Ceci est une traduction automatique !
Cette version du didacticiel a été générée par une traduction automatique. Nous savons que ce n'est pas la solution idéale, mais nous avons estimé qu'une mauvaise traduction valait mieux que pas de traduction du tout.
Page 404 personnalisée¶
Ajoutez nopage à la fin de l'URL dans votre navigateur pour vérifier que la
page 404 existe, et qu'elle contient le texte "Brutus ne peut pas trouver ce que
vous cherchez". La page 404 actuelle ne rend pas toujours les images en raison
d'un problème avec MkDocs.
*Les constructions de MkDocs échouent en cas de liens internes non reconnus, vous devez donc vérifier manuellement cette vérification en modifiant l'URL dans votre navigateur.
Contrôles suivants¶
Le lien suivant devrait vous conduire à la section 1 de la démonstration de BeeWare Docs Tools. Il est inclus pour vérifier les liens entre les pages.
Naviguez vers BeeWare Docs Tools Demo Section One pour les vérifications suivantes.