Full Circle Magazine FR

Outils pour utilisateurs

Outils du site

Piste : • arduino • tuto_python • tuto_python • javascript • python • tuto_python • arduino • arduino • tuto-python
issue204:python

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision		Révision précédente
issue204:python [2024/04/29 07:19] – d52frissue204:python [2024/04/30 15:20] (Version actuelle) – andre_domenech
Ligne 49: Ligne 49:
 Installation de Sphinx Installation de Sphinx
  
-Tout d'abord, les gens de Sphinx vous suggèrent d'utiliser un environnement virtuel pour l'installation. Voici donc les étapes à suivre. Tout d'abord, créez l'environnement virtuel et activez-le. Je crée habituellement un répertoire dans mon dossier des projets appelé « sphinx » et je commence à partir de là. Ouvrez un terminal et procédez comme suit+Tout d'abord, les gens de Sphinx vous suggèrent d'utiliser un environnement virtuel pour l'installation. Voici donc les étapes à suivre. Tout d'abord, créez l'environnement virtuel et activez-le. Je crée habituellement un répertoire dans mon dossier des projets appelé « sphinx » et je commence à partir de là. Ouvrez un terminal et procédez comme suit :
  
 $ python -m venv .venv $ python -m venv .venv
Ligne 68: Ligne 68:
  
 (.venv)$ sphinx-quickstart docs (.venv)$ sphinx-quickstart docs
-Welcome to the Sphinx 7.2.6 quickstart utility.+Bienvenue dans le kit de démarrage rapide de Sphinx 7.2.6.
  
  
Ligne 91: Ligne 91:
 translate text that it generates into that language.** translate text that it generates into that language.**
  
-Please enter values for the following settings (just press Enter to +Veuillez saisir des valeurs pour les paramètres suivants (tapez Entrée pour accepter la valeur par défaut, lorsque celle-ci est indiquée entre crochets).
-accept a default value, if one is given in brackets).+
  
-Selected root path: docs+Chemin racine sélectionné : docs
  
-You have two options for placing the build directory for Sphinx output. +Vous avez deux options pour l'emplacement du répertoire de build de la sortie de Sphinx. 
-Either, you use a directory "_build" within the root path, or you separate +Soit vous utilisez un répertoire "_build" dans le chemin racine, soit vous séparez les répertoires "source" et "build" dans le chemin racine.
-"source" and "build" directories within the root path.+
  
-> Separate source and build directories (y/n) [n]: y+> Séparer les répertoires source et de sortie (y/n) [n]: y
  
-The project name will occur in several places in the built documentation. +Le nom du projet apparaîtra à plusieurs endroits dans la documentation construite. 
-> Project name: sandbox +> Nom du projet: sandbox 
-> Author name(s): Greg Walters +> Nom(s) de(s) l'auteur(s): Greg Walters 
-> Project release []: 0.1+> Version du projet []: 0.1
  
-If the documents are to be written in a language other than English, +Si les documents doivent être rédigés dans une langue autre que l’anglais, vous pouvez sélectionner une langue ici grâce à son identifiant. Sphinx utilisera ensuite cette langue pour traduire les textes que lui-même génère.
-you can select a language here by its language code. Sphinx will then +
-translate text that it generates into that language.+
  
  
 **For a list of supported codes, see **For a list of supported codes, see
 https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language. https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.
-> Project language [en]:+> Project language [en]: 
  
 Here is what the directory tree looks like. Here is what the directory tree looks like.
Ligne 134: Ligne 130:
 (.venv)$ cd docs/source** (.venv)$ cd docs/source**
  
-For a list of supported codes, see+Pour une liste des identifiants supportés, voir
 https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language. https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.
-> Project language [en]:+> Langue du projet [en]: fr
  
 Voici à quoi ressemble l'arborescence des répertoires. Voici à quoi ressemble l'arborescence des répertoires.
Ligne 233: Ligne 229:
 The HTML pages are in docs/build/html.** The HTML pages are in docs/build/html.**
  
-Les deux points qui commencent chacune de ces lignes s'appellent une directive. Chaque fois que vous voulez faire quelque chose de spécial, en dehors des marques de gras ou d'italique, qui sont les mêmes commandes que markdown (.md), donc pour mettre un mot ou une phrase en gras, vous devez entourer la phrase de deux astérisques et l'italique n'en est qu'un.+Les deux points qui commencent chacune de ces lignes s'appellent une directive. Chaque fois que vous voulez faire quelque chose de spécial, en dehors des marques de gras ou d'italique, qui sont les mêmes commandes que markdown (.md), donc pour mettre un mot ou une phrase en gras, vous devez entourer la phrase de deux astérisques et pour l'italique n'en faut qu'un.
  
 Nous verrons d'autres directives dans un instant. Nous verrons d'autres directives dans un instant.
  
-Maintenant, pour créer une version HTML de la documentation de notre projet, utilisez le script sphinx-build, au moins la première fois. Cela doit être fait dans le dossier que vous avez configuré à l'origine, qui, dans mon cas, était /sphinx. Cela indique à Sphinx où se trouve le dossier source et le dossier de construction. Le dossier de construction contiendra nos fichiers HTML finis. Retournez donc dans le dossier sphinx (parent de tout).+Maintenant, pour créer une version HTML de la documentation de notre projet, utilisez le script sphinx-build, au moins la première fois. Cela doit être fait dans le dossier que vous avez configuré à l'origine, qui, dans mon cas, était /sphinx. Cela indique à Sphinx où se trouve le dossier source et le dossier de compilation (build). Le dossier de compilation contiendra nos fichiers HTML finis. Retournez donc dans le dossier sphinx (parent de tout).
  
 (.venv)$ sphinx-build -M html docs/source/ docs/build/ (.venv)$ sphinx-build -M html docs/source/ docs/build/
  
-Running Sphinx v7.2.6 +Sphinx v7.2.6 en cours d'exécution 
-making output directory... done +chargement des traductions [fr]... fait 
-building [mo]: targets for 0 po files that are out of date +création du répertoire de sortie... fait 
-writing output...  +construction en cours [mo] : cibles périmées pour les fichiers po 0 
-building [html]: targets for 1 source files that are out of date +Écriture...  
-updating environment: [new config] 1 added, 0 changed, 0 removed +construction [html] : cibles périmées pour les fichiers sources 1 
-reading sources... [100%] index +mise à jour de l'environnement : [nouvelle configuration] 1 ajouté(s), 0 modifié(s), 0 supprimé(s) 
-looking for now-outdated files... none found +lecture des sources... [100%] index 
-pickling environment... done +Recherche des fichiers périmés... aucun résultat trouvé 
-checking consistency... done +Environnement de sérialisation... fait 
-preparing documents... done +vérification de la cohérence... fait 
-copying assets... copying static files... done +documents en préparation... fait 
-copying extra files... done +copie des ressources... Copie des fichiers statiques... fait 
-done +copie des fichiers complémentaires... fait 
-writing output... [100%] index +fait 
-generating indices... genindex done +Écriture... [100%] index 
-writing additional pages... search done +génération des index... genindex fait 
-dumping search index in English (code: en)... done +Écriture des pages additionnelles... search fait 
-dumping object inventory... done +Export de l'index de recherche en français (code: fr)... fait 
-build succeeded.+Export de l'inventaire des objets... fait 
 +La compilation a réussi.
  
-The HTML pages are in docs/build/html.+Les pages HTML sont dans docs1/build/html.
  
  
Ligne 290: Ligne 287:
 Le fichier config.py Le fichier config.py
  
-Pour l'essentiel, la seule chose que j'ai eu à modifier ici est l'avant-dernière ligne, qui définit le fichier de thème pour la sortie (nous parlerons des thèmes plus loin). Cette ligne est par défaut...+Pour l'essentiel, la seule chose que j'ai eu à modifier ici est l'avant-dernière ligne, qui définit le fichier de thème pour la sortie (nous parlerons des thèmes plus loin). Cette ligne est par défaut :
  
 html_theme = 'alabaster' html_theme = 'alabaster'
Ligne 311: Ligne 308:
    :scale: 50%**    :scale: 50%**
        
-   Si vous souhaitez un autre fichier de thème intégré, il vous suffit de remplacer le mot « alabaster » par le thème de votre choix. Pour la plupart des autres thèmes, c'est aussi simple que cela. +Si vous souhaitez un autre fichier de thème intégré, il vous suffit de remplacer le mot « alabaster » par le thème de votre choix. Pour la plupart des autres thèmes, c'est aussi simple que cela. 
  
 Images dans votre document Sphinx Images dans votre document Sphinx
  
-Afin d'utiliser des images dans votre document Sphinx, vous devrez créer un sous-dossier pour les contenir dans le dossier source. N'utilisez PAS d'espaces dans les noms de fichiers de vos images.+Afin d'utiliser des images dans votre document Sphinx, vous devrez créer un sous-dossier pour les contenir dans le dossier source. N'utilisez PAS d'espaces dans le nom de fichier de vos images.
  
-L'ajout d'une image est assez simple. Vous utilisez la directive « .. image: : », un espace, puis le nom du fichier avec le chemin d'accès. Cela donnerait donc quelque chose comme ceci...+L'ajout d'une image est assez simple. Vous utilisez la directive « .. image:: », un espace, puis le nom du fichier avec le chemin d'accès. Cela donnerait donc quelque chose comme ceci :
  
-.. image: : /images/startup.png+.. image:: /images/startup.png
  
 Il existe des options telles que la hauteur, la largeur, l'échelle et d'autres encore. Voici un exemple de directive image avec l'option scale. Il existe des options telles que la hauteur, la largeur, l'échelle et d'autres encore. Voici un exemple de directive image avec l'option scale.
  
-.. image: : /images/sclbDemo20.png+.. image:: /images/sclbDemo20.png
  
    :scale : 50%    :scale : 50%
Ligne 340: Ligne 337:
 As I said above, you will have to edit the config.py file to set the theme that is used. ** As I said above, you will have to edit the config.py file to set the theme that is used. **
  
-Remarquez l'espacement. L'espacement est TRÈS important dans rst, donc s'il y a une erreur dans la construction, c'est le premier endroit où regarder. En général, toutes les options de directives sont indentées de 4 espaces. Notez également que lorsque vous continuez votre texte après une directive image (ou à peu près n'importe quelle directive), il est important d'avoir au moins une ligne vide entre la directive et le texte suivant.+Remarquez l'espacement. L'espacement est TRÈS important dans rst, donc s'il y a une erreur dans la compilation, c'est le premier endroit où regarder. En général, toutes les options de directives sont indentées de 4 espaces. Notez également que lorsque vous continuez votre texte après une directive image (ou à peu près n'importe quelle directive), il est important d'avoir au moins une ligne vide entre la directive et le texte suivant.
  
 Création d'un thème pour votre document Création d'un thème pour votre document
  
-Vous devrez éditer le fichier config.py afin de changer le thème de votre document. Il existe de NOMBREUX thèmes disponibles pour s'adapter à votre style. Une page Web présentant une galerie de thèmes est disponible à l'adresse suivante +Vous devrez éditer le fichier config.py afin de changer le thème de votre document. Il existe de NOMBREUX thèmes disponibles pour s'adapter à votre style. Une page Web présentant une galerie de thèmes est disponible à l'adresse suivante :
  
 https://sphinx-themes.org/#theme-mozilla-sphinx-theme . https://sphinx-themes.org/#theme-mozilla-sphinx-theme .
  
-Mon thème préféré est bizstyle, qui est intégré. Il y a 10 thèmes différents qui sont déjà intégrés dans Sphinx. Tout autre thème que vous souhaiteriez utiliser devra être téléchargé et installé. Certains thèmes ont des étapes spéciales à suivre, alors suivez les instructions pour ce thème.+Mon thème préféré est bizstyle, qui est intégré. Il y a 10 thèmes différents qui sont déjà intégrés dans Sphinx. Tout autre thème que vous souhaiteriez utiliser devra être téléchargé et installé. Certains thèmes ont des étapes spéciales à suivre, alors suivez les instructions pour un tel thème.
  
 Comme je l'ai dit plus haut, vous devrez éditer le fichier config.py pour définir le thème utilisé. Comme je l'ai dit plus haut, vous devrez éditer le fichier config.py pour définir le thème utilisé.
Ligne 367: Ligne 364:
 Quelques autres directives utiles Quelques autres directives utiles
  
-Il y a BEAUCOUP trop de directives pour essayer de les couvrir toutes ici, et il y a beaucoup de sites Web qui couvrent les premières directives, donc je ne couvrirai que quelques-unes de celles que j'utilise couramment.+Il y a BEAUCOUP trop de directives pour essayer de les couvrir toutes ici et il y a beaucoup de sites Web qui couvrent les premières directives ; aussi, je ne couvrirai que quelques-unes de celles que j'utilise couramment.
  
 N'oubliez pas que l'aspect des directives dans le produit fini dépend du thème que vous utilisez. N'oubliez pas que l'aspect des directives dans le produit fini dépend du thème que vous utilisez.
  
-Advertissements+Avertissements
  
 J'utilise souvent les avertissements pour mettre en évidence des notes ou des avertissements. Selon l'une des premières pages Web consacrées aux directives, les « avertissements (« messages de sécurité » ou « mentions de danger ») peuvent apparaître partout où un élément de corps ordinaire peut apparaître. Elles contiennent des éléments de corps arbitraires. En règle générale, un avertissement est présenté sous la forme d'un bloc décalé dans un document, parfois souligné ou ombré ». J'utilise souvent les avertissements pour mettre en évidence des notes ou des avertissements. Selon l'une des premières pages Web consacrées aux directives, les « avertissements (« messages de sécurité » ou « mentions de danger ») peuvent apparaître partout où un élément de corps ordinaire peut apparaître. Elles contiennent des éléments de corps arbitraires. En règle générale, un avertissement est présenté sous la forme d'un bloc décalé dans un document, parfois souligné ou ombré ».
  
-Voici une simple note en code...+Voici une simple note en code :
  
  
Ligne 397: Ligne 394:
 .. Note:: .. Note::
  
-The actual entry method depends on your Operating system. Some of the options might not be available on your system.+La méthode de saisie réellement utilisée dépend de votre système d'exploitation. Certaines options peuvent ne pas être disponibles dans votre système.
  
 N'oubliez pas que l'espacement est TRÈS important, tant avant qu'après la directive. N'oubliez pas que l'espacement est TRÈS important, tant avant qu'après la directive.
Ligne 405: Ligne 402:
 Blocs de code Blocs de code
  
-Vous pouvez utiliser des blocs de code pour mettre en évidence des commandes de la console ou des extraits de code. Voici la directive permettant de mettre en évidence une commande de terminal.+Vous pouvez utiliser des blocs de code pour mettre en évidence des commandes de la console ou des extraits de code. Voici la directive permettant de mettre en évidence une commande de terminal :
  
-.. code: : console+.. code:: console
  
    python colours1.py    python colours1.py
Ligne 448: Ligne 445:
 Les listes à puces sont VRAIMENT faciles à utiliser. Il suffit de placer un tiret devant chaque élément. Les listes à puces sont VRAIMENT faciles à utiliser. Il suffit de placer un tiret devant chaque élément.
  
-From top to bottom on the left side of the image are:+Du haut en bas, côté gauche de l'image sont :
  
-- Hex value+- La valeur Hex 
  
-- RGB Value+- La valeur RGB 
  
-- Calculated Closest Colour name+- Nom de la couleur calculée au plus près
  
-- Calculated Best Colour for text on this colour.+- La meilleure couleur calculée pour du texte dans cette couleur.
  
  
Ligne 477: Ligne 474:
 Until next time, as always; stay safe, healthy, positive and creative!** Until next time, as always; stay safe, healthy, positive and creative!**
  
-Le résultat est le suivant...+Le résultat est le suivant :
  
 Comme je l'ai dit, il existe de nombreuses autres directives que vous pouvez utiliser (et que vous utiliserez probablement). Dans la section suivante, je vous propose quelques-unes de mes pages Web en reStructured Text préférées. Comme je l'ai dit, il existe de nombreuses autres directives que vous pouvez utiliser (et que vous utiliserez probablement). Dans la section suivante, je vous propose quelques-unes de mes pages Web en reStructured Text préférées.
Ligne 491: Ligne 488:
 https://docutils.sourceforge.io/docs/ref/rst/directives.html#top https://docutils.sourceforge.io/docs/ref/rst/directives.html#top
  
-Au vu de mon nombre de pages, il est grand temps pour moi de clore ce mois.+Au vu de mon nombre de pages, il est grand temps pour moi de terminer.
  
 Jusqu'à la prochaine fois, comme toujours, restez en sécurité, en bonne santé, positifs et créatifs ! Jusqu'à la prochaine fois, comme toujours, restez en sécurité, en bonne santé, positifs et créatifs !
  
issue204/python.1714367990.txt.gz · Dernière modification : 2024/04/29 07:19 de d52fr