|
Original |
Translation |
|
1
|
Building the documentation
|
Construire la documentation
|
|
2
|
You need to have Python 2.4 or higher installed; the toolset used to build the docs is written in Python. It is called *Sphinx*, it is not included in this tree, but maintained separately. Also needed are the docutils, supplying the base markup that Sphinx uses, Jinja, a templating engine, and optionally Pygments, a code highlighter.
|
If vous faut Python 2.4 ou supérieur d’installé ; l’outil utilisé pour construire la documentation est écrit en Python. Il s’appele *Sphinx*, il n'est pas inclus dans cette arborescence mais maintenu séparément. Il faut également docutils, qui fournit le système de balisage de base utilisé par Sphinx, Jinja, un moteur de templates, et facultativement Pygments, un outil de coloration syntaxique.
|
|
3
|
|
|
|
4
|
Luckily, a Makefile has been prepared so that on Unix, provided you have installed Python and Subversion, you can just run ::
|
Heureusement un fichier Makefile existe, de façon à ce que sous Unix, si vous avez installé Python et Subversion, vous puissiez lancer ::
|
|
5
|
|
6
|
to check out the necessary toolset in the `tools/` subdirectory and build the HTML output files. To view the generated HTML, point your favorite browser at the top-level index `build/html/index.html` after running "make".
|
|
|
7
|
Available make targets are:
|
Les différentes cibles de make sont :
|
|
8
|
"html", which builds standalone HTML files for offline viewing.
|
"html", qui construit les fichiers HTML permettant une consultation en mode déconnecté.
|
|
9
|
"htmlhelp", which builds HTML files and a HTML Help project file usable to convert them into a single Compiled HTML (.chm) file -- these are popular under Microsoft Windows, but very handy on every platform.
|
|
|
10
|
To create the CHM file, you need to run the Microsoft HTML Help Workshop over the generated project (.hhp) file.
|
Pour créer le fichier CHM, vous devez exécuter le Microsoft HTML Help Workshop sur le projet a généré (fichier .hhp).
|