| Authors: | Nicolas Bozon, Gérald Fenoy, Jeff McKenna |
|---|---|
| Last Updated: | $Date: 2011-12-07 14:19:47 +0100 (Wed, 07 Dec 2011) $ |
Table des matières
La structure actuelle du processus de documentation du projet ZOO est pour les développeurs avec les accès SVN de commit pour maintenir leurs documents en format reStructuredText, et donc tous les documents vivent dans le répertoire /docs dans le SVN. Le genérateur de documentation Sphinx est utilisé pour convertir les fichiers ReStructuredText en html, et le site en ligne est ensuite mis à jour sur une base horaire.
le reStructuredText rapide de Docutils
les directives reStructuredText de Docutils
le livre de base du StructuredText de Sphinx
cherchez dans la liste de diffusion de Sphinx
Tout le texte doit être coupé avant que les lignes ne fassent environ plus de 80 caractères, comme pour le code source.
Note
Vous pouvez naviguer dans les versions des paquets Sphinx ici, et ensuite installez la version exacte comme ceci:
easy_install Sphinx==1.0.7
sous Windows:
installez Python 2.X
téléchargez setuptools
assurez vous que le répertoire C:/Python2X/Scripts est dans le Path
exécutez ce qui suit dans la ligne de commande:
easy_install Sphinx
...vous devriez voir le message : “Finished processing dependencies for Sphinx”
Note
Assurez vous d’installer Sphinx 1.0 ou plus récent. Voir les notes ci-dessus.
installez MiKTeX si vous souhaitez générer des pdfs
récupérez le répertoire /docs depuis le SVN, comme ceci:
svn checkout http://svn.zoo-project.org/svn/trunk zoo-project
dans le répertoire /docs, exécutez:
make html
ou
make latex
ou
Sous Linux:
assurez-vous d’avoir les paquets de développement Python et setuptools installés. Sous Ubuntu:
sudo apt-get install python-dev
sudo apt-get install python-setuptools
installez sphinx en utilisant easy_install:
sudo easy_install Sphinx
Note
Assurez vous d’installer Sphinx 1.0 ou plus récent. Voir les notes ci-dessus.
récupérez le répertoire /docs depuis le SVN, comme ceci:
svn checkout http://svn.zoo-project.org/svn/trunk zoo-project
pour générer la documentation, depuis votre répertoire /docs ZOO, lancez:
make html
ou
make latex
la sortie HTML sera écrite dans le sous-répertoire build/html.
Note
S’il y a plus d’une seule traduction, les commandes ci-dessus généreront automatiquement toutes les traductions.
Sous Mac OS X:
installez sphinx en utilisant easy_install:
sudo easy_install Sphinx
Note
Assurez vous d’installer Sphinx 1.0 ou plus récent. Voir les notes ci-dessus.
installez MacTex si vous voulez générer les pdfs
récupérez le répertoire /docs depuis le SVN, comme ceci:
svn checkout http://svn.zoo-project.org/svn/trunk zoo-project
pour générer la documentation, depuis votre répertoire /docs ZOO, lancez:
make html
ou
make latex
la sortie HTML sera écrite dans le sous-répertoire build/html.