1. djangotradfr
  2. Untitled project
  3. djangofrdoc

Overview

La documentation dans cette arborescence est en fichier texte et peut être lue en utilisant
un simple éditeur de texte.

Techniquement parlant, elle utilise ReST (reStructuredText) [1], et le système de
documentation Sphinx [2].  Cela autorise à construire la doc dans une autre forme plus
facile à parcourir.

Pour créer une version HTML de la doc:

* Installer Sphinx (utilisez ``pip install Sphinx`` ou une autre méthode)

* Dans ce répertoire Docs/, tapez ``make html`` (ou ``make.bat html`` sur
  Windows) dans un shell.

La documentation dans _build/html/index.html peut alors être visionnée dans un navigateur web.

[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx.pocoo.org/