[#2633] Petite doc d'installation
authorEric Mc Sween <eric.mcsween@auf.org>
Fri, 10 Feb 2012 18:01:32 +0000 (13:01 -0500)
committerEric Mc Sween <eric.mcsween@auf.org>
Fri, 10 Feb 2012 18:01:32 +0000 (13:01 -0500)
doc/index.rst
doc/installation.rst [new file with mode: 0644]

index 2a60a4d..486ae26 100644 (file)
@@ -4,4 +4,5 @@ Documentation d'auf.django.references
 .. toctree::
    :maxdepth: 2
 
+   installation
    etablissements
diff --git a/doc/installation.rst b/doc/installation.rst
new file mode 100644 (file)
index 0000000..a0ab4d6
--- /dev/null
@@ -0,0 +1,18 @@
+Installation
+============
+
+Pour utiliser ce module, il suffit d'ajouter ``'auf.django.references'`` à la liste
+``INSTALLED_APPS`` dans le fichier ``settings.py``::
+
+    INSTALLED_APPS = (
+        ...
+        'auf.django.references',
+        ...
+    )
+
+Certaines fonctionnalités nécessitent la publication de fichiers statiques
+contenus dans le répertoire ``static`` de l'app ``auf.django.references``. La
+meilleure façon de les rendre disponible est d'utiliser l'app
+``django.contrib.staticfiles`` disponible à partir de Django 1.3. Si vous êtes
+bloqués dans une version moins récente de Django, considérez l'utilisation de
+l'app ``django-staticfiles`` qui offre les mêmes services.