Installer Sphinx sur Windows,

python logoArticle in french: I will probably translate this when I will have more time.

Cet article explique comment installer Sphinx sur Windows, pour les personnes qui ne sont pas familières avec l’utilisation avance de Windows (les auteurs par exemple) et/ou qui n’ont pas l’intention d’utiliser Python par la suite.

J’ai décidé d’écrire cet article car il y a beaucoup de tutoriels qui expliquent comment faire mais avec une quantité non négligeable de conneries inutiles pour les non programmeurs.

  • Niveau: Débutant, Novice

NB: A la fin se trouve la liste des logiciels que je vous fait télécharger avec une explication de ce que c’est.

Partie 1:

Cette partie explique comment installer les logiciels de base pour mettre en place “l’environnement” Windows pour python et sphinx. C’est l’etape la plus compliquée, mais tout se fait dans l’interface graphique.

  • Télécharger et Installer une version de Python: Python2.7 ou Python3.3.

Si vous utilisez le logiciel de modélisation 3D Blender Python est deja installé, vous pouvez passer a l’étape suivante. Si vous avez l’intention d’utiliser Blender dans le futur, installez Python2.7

02 python.exe to PATH

A l’installation python propose d’ajouter python.exe au “PATH” le faire maintenant permet d’économiser du temps par la suite.

En tant qu’administrateur ajoutez les repertoires suivants a la variable nommée “PATH

C:\Python33

et

C:\Python33\Scripts

03-pathAvec un clic droit sur la variable path il suffit d’ajouter un repertoire.

Partie 2:

Maintenant que l’environnement windows est etabli, il faut installer le logiciel de gestion de package python pour pouvoir installer Sphinx. Cela s’execute a la ligne de commande (la fenetre noire avec du texte que l’on lance en tapant “cmd.exe” dans la barre de recherche qui se trouve dans le menu “Démarrer” de Windows) ; malgrès l’aspect peut rassurant de la ligne de commande, l’étape 1 a permis de limiter grandement le nombre de commandes a entrer pour venir a bout de l’étape 2, qui plus est il n’y a pas grand chose a taper.

  • Telecharger Setuptools (ez_setup.py) https://pypi.python.org/pypi/setuptools#files
  • lancer une console de commande: (Start>[ cmd.exe ])

si le fichier ez_setup.py est dans le repertoire “Downloads” faites:

cd Downloads
ez_setup.py

Setuptools vas s’installer. (voilà le plus dur est passé.)

  • Maintenant il ne reste plus qu’a installer sphinx avec la commande suivante:

easy_install.exe sphinx pygments

Cela vas prendre entre cinq et dix minutes d’installation —Parce que ma connection internet est a chier—.

C’est fini. Bravo.

Tester Sphinx:

Il ne reste plus qu’a creer un repertoire, et lancer sphinx pour generer les fichiers du projet: (ont peu tres bien creer un repertoire avec l’interface graphique, je montre ici comment creer un repertoire avec la ligne de commande –aucune obligations–)

mkdir <nom_du_repertoire>
cd <Nom_du_repertoire>
sphinx-quickstart

Apres avoir répondu aux questions de sphinx le projet est initialisé.  vous pouvez taper “make.bat html” pour générer le livre au format html.

il vous suffit d’ouvir le fichier “index.html” qui se trouve dans le repertoire “_build\html\”

Au Final

Le repertoire Python contenant Python et Sphinx fait: 70 Mo.

Glossaire des commandes:

“mkdir” est la commande qui permet de creer des repertoires. Attention, si votre repertoire contient des espaces mettez des guillemets ” ou ‘ avant et apres le nom du repertoire.

“cd” est la commande qui permet de changer de repertoire (lit. change directory)

“sphinx-quickstart” est la commande qui lance le générateur de projet sphinx.

“make.bat” est la commande qui génère les fichiers finaux de sphinx (vous pouvez la lancer autant de fois que vous voulez après chaque modification de votre texte. j’en parlerai dans un autre article).

make.bat prends plusieurs options: “html”, “epub” et “pdf”.

  • “html” génère le ebook/site web dans le repertoire _build\html
  • “epub” génère le ebook pour liseuses électroniques/tablettes au format epub.
  • “pdf” utilise LaTeχ (MikTeX) pour générer un fichier PDF… d’après mon experience il faut bidouiller un peu, c’est pas bien compliqué, mais je ferai aussi un article a ce propos… Si vous voulez faire des PDF c’est une bonne idée d’ajouter le repertoire où se trouve latex.exe dans la variable d’environnement PATH (cf. second point de la partie1)

Les logiciels utilisés:

  1. Python : est un language de programmation, qui est utilisé un peu partout, par exemple dans l’aide de Google. les fichiers python sont remarquables par leurs extention qui fini par .py
  2. Rapidee : c’est un logiciel libre qui permet d’editer l’environnement de Windows, “l’environnement” est un terme qui signifie qui “montre” a Windows où se trouvent les logiciels. Cela est tres utile pour les developpeurs ou les personnes qui veulent utiliser la ligne de commande. cela leurs evite de tapper le chemin complet des logiciels pour les faires fonctionner (ie. c’est l’equivalent des icones raccourcis mais en ligne de commande.)  // Si vous connaissez une maniere plus aise de modifier les variables d’environnement je suis preneur, mais rapidee est pas mal du tout (avis de geek…)
  3. setuptools : est un gestionnaire de packages pour Python. Ici cela sert a installer sphinx qui est un package de Python. (c’est aussi plus securisé de l’installer avec ez_setup.py car il supporte les ordinateurs recents)
  4. pygments : c’est un package python qui permet la coloration syntaxique. Sphinx l’utilise.

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial 3.0 France License.

Advertisements