Démarrage rapide

Maintenant que tout est installé, il ne vous reste plus qu’à choisir un dossier (que vous pouvez préalablement créer) et y ouvrir un terminal (console).

Note

Pour ouvrir un terminal dans un dossier :

Dans un explorateur de fichiers, s’affiche une ligne en haut : l’arborescence.

Sous Linux, il suffit d’y faire un clic droit sur un nom du dossier et de choisir dans le menu contextuel : Ouvrir un terminal

_images/ouvrirTerminal.png

Sous Window, il suffit de cliquer sur l’icône au début de cette ligne (dossier jaune), puis de taper : cmd. Ou de sélectionner le dossier puis d’y faire un clic droit et choisir Ouvrir une fenêtre de commandes ici

Et, y taper : sphinx-quickstart docs

_images/quickstart.png

Après avoir répondu à quelques questions :

  • Séparer les répertoires build et source (y/n) [n]: (tapez : y)

  • Nom du projet: (par exemple : test)

  • Nom(s) de l’auteur: (par exemple : moi)

  • version du projet []: (par exemple : 0.1)

  • Langue du projet [en]: (ne tapez rien)

Note

Vos quatre dernières réponses sont enregistrées dans le fichier /docs/source/config.py. Et, vous pourrez le modifier à tout moment.

L’outil créera les dossiers et fichiers nécessaires (dans le dossier que vous avez choisi).

Et, notamment, le fichier /docs/source/index.rst. Ce fichier contient le texte de la page d’accueil de votre site.

reStructuredText