Contribuer

Documentation

Ce dépôt utilise Sphinx, un puissant générateur de documentation, pour créer une documentation de haute qualité. Il vous permet d’écrire de la documentation au format reStructuredText (reST) ou au format markdown (MyST) et fournit des outils pour des flux de travail complexes de documentation et de publication.

Pré-requis

Pour configurer l’environnement de développement et générer la documentation, suivez ces étapes à l’intérieur du dépôt cloné:

  1. Créer un environnement virtuel

python3 -m venv venv

  1. Activer l’environnement virtuel

. activate

  1. Installer les dépendances requises

pip install -r docs/requirements.txt

Construire la documentation

Étant donné que nous devons prendre en charge de nombreuses langues, un système de génération docs/build.py a été ajouté pour prendre en charge les génération internationalisées pour toute langue configurée.

Ainsi, générer la documentation est aussi simple que:

python3 docs/build.py

Ce qui produira une sortie HTML dans le dossier public.

Internationalisation (i18n)

https://github.com/sphinx-doc/sphinx-intl

sphinx-intl est un outil qui propose plusieurs fonctionnalités facilitant la traduction et l’application de traduction aux documents générés par Sphinx.