From 7cb27ecabcc3420f9404e9d6ce987340b00b38c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Metrich?= Date: Wed, 20 Nov 2024 22:56:01 +0100 Subject: [PATCH] fix: update documentation for consistency and clarity, including renaming files and adjusting formatting --- content/common/boitier.inc.rst | 9 +++++---- ...ur.rst => carte-mere-mono-test-afficheur.inc.rst} | 4 ++-- content/mono/carte-mere-mono.rst | 12 ++++-------- ...s.rst => test-logiciel-mono-requirements.inc.rst} | 0 content/mono/test-logiciel-mono.rst | 6 +++--- ...st-mono-mesures.rst => test-mono-mesures.inc.rst} | 2 -- 6 files changed, 14 insertions(+), 19 deletions(-) rename content/mono/{carte-mere-mono-test-afficheur.rst => carte-mere-mono-test-afficheur.inc.rst} (97%) rename content/mono/{test-logiciel-mono-requirements.rst => test-logiciel-mono-requirements.inc.rst} (100%) rename content/mono/{test-mono-mesures.rst => test-mono-mesures.inc.rst} (98%) diff --git a/content/common/boitier.inc.rst b/content/common/boitier.inc.rst index 0e767dd..eb1bfb7 100644 --- a/content/common/boitier.inc.rst +++ b/content/common/boitier.inc.rst @@ -5,10 +5,12 @@ Les boîtiers utilisés pour ce routeur sont de type industriel, fabriqués en A Ils sont conformes aux normes de sécurité industrielles. En fonction du nombre de sorties à contrôler, deux références peuvent être fournies : + * Thalassa **NSYTBS24198** : ce boîtier convient pour les configurations à **1** ou **2** sorties, pouvant être installées en mode portrait ou paysage. * Thalassa **NSYTBS29248** : ce boîtier convient pour les configurations à **3** ou **4** sorties, à installer **uniquement en mode portrait**. Il y a peu de contraintes à respecter, voici la liste : + * Le **presse-étoupe** doit être installé sur le **côté inférieur** pour protéger contre la poussière et les éventuels ruissellements. * Le·s **dissipateur·s** doit·vent être installé·s sur le·s côté·s **vertical·aux**. C'est **impératif** pour assurer un bon refroidissement. @@ -51,8 +53,7 @@ Outils nécessaires Perçage pour le·s dissipateur·s ------------------------------- - Veuillez vous référer à la section :ref:`percage-du-boitier`. - +Veuillez vous référer à la section :ref:`percage-du-boitier`. Perçage pour chaque étage de sortie triac ----------------------------------------- @@ -81,7 +82,7 @@ Vu du dessus, il est possible de pointer le futur perçage à l'endroit le plus Pour percer, l'étage de sortie doit être retiré. Le perçage doit être effectué avec un foret de **3 mm** de diamètre. -Pour ajuster la hauteur de la carte de sortie, un plot en plastique de 10 mm de haut est installé à l'aide d'une vis M3 en plastique. +Pour ajuster la hauteur de la carte de sortie, un plot en plastique de **10 mm** de haut est installé à l'aide d'une vis **M3** en plastique. .. figure:: ../img/Entretoise-sortie.png :alt: Plot @@ -105,4 +106,4 @@ En utilisant la même méthode, vous pouvez marquer et percer le boîtier aux di Pointage carte mère -Pour éviter qu'elle ne repose sur les points de fixation au fond du boîtier, un plot en plastique de 10 mm de hauteur est installé à l'aide d'une vis M4 sur tous les trous percés, de la même manière que pour l'étage de sortie. +Pour éviter qu'elle ne repose sur les points de fixation au fond du boîtier, un plot en plastique de **10 mm** de hauteur est installé à l'aide d'une vis **M4** sur tous les trous percés, de la même manière que pour l'étage de sortie. diff --git a/content/mono/carte-mere-mono-test-afficheur.rst b/content/mono/carte-mere-mono-test-afficheur.inc.rst similarity index 97% rename from content/mono/carte-mere-mono-test-afficheur.rst rename to content/mono/carte-mere-mono-test-afficheur.inc.rst index 4c02c04..f7b9329 100644 --- a/content/mono/carte-mere-mono-test-afficheur.rst +++ b/content/mono/carte-mere-mono-test-afficheur.inc.rst @@ -1,5 +1,3 @@ -.. _carte-mere-mono-test-afficheur: - Test de la partie *afficheur* ----------------------------- @@ -11,6 +9,8 @@ Pour cela, nous aurons besoin d'un croquis spécifique qui sera téléchargé da :local: :depth: 1 +.. _test-logiciel-mono-display-requirements: + Pré-requis ^^^^^^^^^^ diff --git a/content/mono/carte-mere-mono.rst b/content/mono/carte-mere-mono.rst index 17fdf1d..65c35de 100644 --- a/content/mono/carte-mere-mono.rst +++ b/content/mono/carte-mere-mono.rst @@ -7,14 +7,10 @@ Plusieurs versions du :term:`PCB` peuvent exister. Bien qu'elles fonctionnent toutes de la même manière, chaque nouvelle version offre plus de flexibilité que la précédente ainsi que quelques améliorations mineures, essentiellement des aspects pratiques (facilité d'accès des entrées/sorties de l'Arduino, …). -.. contents:: Sommaire - :local: - :depth: 1 - .. toctree:: :maxdepth: 2 - carte-mere-mono-inventaire.rst - carte-mere-mono-synthese.rst - carte-mere-mono-soudure.rst - carte-mere-mono-tests.rst + carte-mere-mono-inventaire + carte-mere-mono-synthese + carte-mere-mono-soudure + carte-mere-mono-tests diff --git a/content/mono/test-logiciel-mono-requirements.rst b/content/mono/test-logiciel-mono-requirements.inc.rst similarity index 100% rename from content/mono/test-logiciel-mono-requirements.rst rename to content/mono/test-logiciel-mono-requirements.inc.rst diff --git a/content/mono/test-logiciel-mono.rst b/content/mono/test-logiciel-mono.rst index 92e1863..4bd2152 100644 --- a/content/mono/test-logiciel-mono.rst +++ b/content/mono/test-logiciel-mono.rst @@ -15,8 +15,8 @@ Tests logiciel :local: :depth: 1 -.. include:: test-logiciel-mono-requirements.rst +.. include:: test-logiciel-mono-requirements.inc.rst -.. include:: carte-mere-mono-test-afficheur.rst +.. include:: carte-mere-mono-test-afficheur.inc.rst -.. include:: test-mono-mesures.rst \ No newline at end of file +.. include:: test-mono-mesures.inc.rst \ No newline at end of file diff --git a/content/mono/test-mono-mesures.rst b/content/mono/test-mono-mesures.inc.rst similarity index 98% rename from content/mono/test-mono-mesures.rst rename to content/mono/test-mono-mesures.inc.rst index c627efa..b488ffa 100644 --- a/content/mono/test-mono-mesures.rst +++ b/content/mono/test-mono-mesures.inc.rst @@ -1,5 +1,3 @@ -.. _test-mono-mesures: - Test de la partie *mesures* ---------------------------