AdeliaDoc est un outil de type "ligne de commande" Windows® de la suite Adélia Studio. Il est installé en standard avec Adélia Studio sur un système d'exploitation Windows®.
Etant donné qu'AdeliaDoc s'appuie sur l'outil de génération de documentation Sphinx, il est nécessaire d'installer cet outil avant l'utilisation d'AdeliaDoc.
Sphinx étant lui même un produit développé en Python, il est également nécessaire d'installer un environnement Phyton, version 3.6 ou supérieure, sur le poste où sera exécuté AdeliaDoc.
Enfin, dans le cas où vous souhaiteriez produire de la documentation au format PDF, il faut de surcroît installer un environnement TeX/LaTeX complet (MikTex de préférence).
Nous vous suggérons de ce fait de procéder à l'installation des produits tiers requis dans l'ordre suivant :
- Installation de Python 3.6+ :
- Avant d'installer Python, vous pouvez vérifier qu'une version n'a pas déjà été installée en ouvrant une fenêtre de commande Windows® (⊞Win-r et saisir cmd ), en tapant la commande python --version puis en pressant la touche Entrée.
- Si Python est déjà présent, s'affiche alors à l'écran la version installée.
Dans le cas contraire, ou si la version est inférieure à la version 3.6, reportez-vous au "Hitchhikers Guide to Python's" et à la section "Installing Python 3 on Windows" pour l'installation ou la mise à jour de Python. - Alternativement, il est également possible de récupérer directement un installeur depuis le lien suivant : https://www.python.org/downloads/.
- Installation de Sphinx 3.5+ :
- Une fois Python installé, reportez-vous à la section "Windows" de la page d'aide d'installation de Sphinx pour procéder à son installation via Python Package Installer.
- Alternativement, vous pouvez également installer Python et Sphinx via Chocolatey.
Dans ce cas, l'installation préalable de Chocolatey est requise. Référez-vous ensuite à la page Chocolatey dédiée au package Sphinx.
- Installation de MikTex (uniquement pour PDF) :
- Suivez les instructions données sur le site MikTex.org.
- Pour que la chaine de production PDF fonctionne correctement, veillez à ce que le répertoire des binaires de MikTex soit bien présent dans le
PATHde votre session Windows® (".\MiKTeX\miktex\bin\x64").
- MikTex requiert la présence Perl. Il est donc également nécessaire de procéder à l'installation de cet outil.
- Enfin, et s'il n'a pas déjà été installé, ouvrez le gestionnaire de package de MikTex et installez le package
latexmk.