doc: nouveau readme

2 files changed, 13 insertions, 192 deletions

diff --git a/README.md b/README.md
deleted file mode 100644
index b940b9b..0000000
--- a/README.md
+++ /dev/null
@@ -1,192 +0,0 @@
-# celcatsanitizer
-celcatsanitizer est un système qui permet de récupérer des emplois du
-temps Celcat au format XML pour les afficher correctement.
-
-## Pourquoi ?
-Parce que les emplois du temps Celcat sont peu lisibles et peuvent
-facilement faire planter un navigateur, à cause du surplus
-d’informations affichées.
-
-## Comment faire tourner celcatsanitizer chez moi ?
-celcatsanitizer est écrit en Python 3. Il dépend des bibliothèques
-suivantes :
- * [Django 2.0](https://www.djangoproject.com/)
- * [requests](http://docs.python-requests.org/en/master/)
- * [BeautifulSoup4](https://www.crummy.com/software/BeautifulSoup/bs4/doc/)
- * [icalendar](https://icalendar.readthedocs.io/en/latest/)
-
-Pour installer celcatsanitizer, il est possible d’utiliser
-[git](https://git-scm.com/).
-
-Pour tester celcatsanitizer, il est recommandé d’utiliser
-[SQLite](https://www.sqlite.org/) ou
-[PostgreSQL](https://www.postgresql.org/).
-
-Pour la production, il est recommandé d’utiliser PostgreSQL (avec le
-driver
-[psycopg2](http://initd.org/psycopg/docs/install.html#binary-install-from-pypi)
-et de mettre le tout dans un environnement virtuel.
-
-Aucun autre SGBD n’a été testé, mais depuis la version 0.8.0,
-celcatsanitizer n’utilise plus de fonctions SQL brutes
-spécifiques. Tous les SGBD supportés par Django devraient fonctionner
-sans poser de problèmes.
-
-### Installation
-Il est préférable d’utiliser un environnement virtuel, mais ce n’est
-pas obligatoire. Si vous ne souhaitez pas utiliser un environnement
-virtuel, passez directement à l’installation des dépendances.
-
-#### Création de l’environnement virtuel
-Déplacez-vous dans le répertoire souhaité, installez l’environnement
-virtuel, et activez-le :
-
-```bash
-$ virtualenv -p python3 celcatsanitizer
-$ cd celcatsanitizer
-$ source bin/activate
-```
-
-Il est possible que votre version de pip soit ancienne. Si vous le
-souhaitez, mettez ce programme à jour :
-
-```bash
-$ pip install --upgrade pip
-```
-
-#### Installation des dépendances
-
-```bash
-$ pip install requests django beautifulsoup4 icalendar
-```
-
-Si vous utilisez PostgreSQL, vous allez avoir besoin du driver
-psycopg2 :
-
-```bash
-$ pip install psycopg2
-```
-
-SQLite n’a pas besoin de driver.
-
-#### Création du répertoire Django
-
-```bash
-$ django-admin startproject celcatsanitizer
-$ cd celcatsanitizer
-```
-
-#### Récupération des sources de celcatsanitizer
-
-```bash
-$ git clone https://git.pa1ch.fr/alban/celcatsanitizer.git edt
-```
-
-Pour la production, il est recommandé d’utiliser une version stable,
-accessibles à travers les tags git.
-
-#### Configuration de Django
-Dans le fichier celcatsanitizer/settings.py, vous devrez renseigner
-plusieurs informations.
-
-##### Configuration des administrateurs
-[Vous pouvez retrouver la documentation de la variable ADMIN sur le
-site de
-Django.](https://docs.djangoproject.com/fr/2.0/ref/settings/#admins)
-
-Cette variable est obligatoire.
-
-##### Configuration de l’internationalisation
-Ce passage n’est pas obligatoire. [Vous pouvez retrouver la
-documentation de l’internationalisation sur le site de
-Django.](https://docs.djangoproject.com/fr/2.0/topics/i18n/)
-
-##### Configuration de la base de données
-[Vous pouvez retrouver la documentation de la base de données sur le
-site de
-Django.](https://docs.djangoproject.com/fr/2.0/ref/settings/#databases)
-
-##### Configuration du mode de Django
-Si jamais vous utiliser Django en production, vous **devez** mettre la
-variable DEBUG à False.
-
-##### Ajout de celcatsanitizer dans la liste des applications Django
-Ajoutez la chaine de caractère « edt » à la fin de la liste
-INSTALLED_APPS.
-
-##### Configuration des flatpages
-celcatsanitizer utilise les flatpages pour rendre les pages
-« contact » et « à propos ». Vous pouvez retrouver le guide
-d’installation sur [le site de
-Django](https://docs.djangoproject.com/fr/2.0/ref/contrib/flatpages/#installation). Effectuez
-uniquement les deux premières étapes, celcatsanitizer enregistre déjà
-une route pour les pages statiques, et la commande de l’étape 4 sera
-effectuée plus loin.
-
-##### Ajout du processeur de contexte de celcatsanitizer
-Cette étape est fortement recommandée, mais pas obligatoire.
-
-Rajoutez la chaine de caractères 'edt.views.ctx_processor' à la liste
-'context_processors' dans la variable « TEMPLATES ».
-
-##### Ajout des URLs de celcatsanitizer
-Dans le fichier celcatsanitizer/urls.py, importez la fonction
-django.conf.urls.include, et ajoutez url(r'^', include("edt.urls")) à
-la **fin** de la liste urlspatterns.
-
-##### Génération de la base de données
-Générer les migrations de celcatsanitizer, puis appliquez-les :
-
-```bash
-$ ./manage.py makemigrations edt
-$ ./manage.py migrate
-```
-
-##### Gestion des fichiers statiques
-Si vous êtes en production, vous devez renseigner l’emplacement de vos
-fichiers statiques dans la variable
-[STATIC_ROOT](https://docs.djangoproject.com/fr/2.0/ref/settings/#std:setting-STATIC_ROOT)
-de la configuration de Django, puis exécuter la commande suivante :
-
-```bash
-$ ./manage.py collectstatic
-```
-
-Cette étape est inutile si vous êtes en mode de déboguage.
-
-### Lancement de celcatsanitizer
-Si vous êtes en mode de déboguage, lancez le serveur de cette
-manière :
-
-```bash
-$ ./manage.py runserver
-```
-
-Si vous êtes en production, il n’est pas recommandé d’utiliser ce
-serveur. Exécutez Django avec le module mod_wsgi d’Apache, ou avec un
-serveur [gunicorn](http://gunicorn.org/) derrière nginx.
-
-### Configuration de celcatsanitizer
-#### Administrateur
-Pour avoir accès à l’interface d’administration, vous devez créer un
-utilisateur avec les droits administrateur. Pour cela, exécutez la
-commande suivante :
-
-```bash
-$ ./manage.py createsuperuser
-```
-
-Renseignez ensuite votre nom d’utilisateur, mot de passe et adresse
-email au fur et à mesure.
-
-#### Pages statiques
-Comme indiqué plus haut, celcatsanitizer utilise l’application
-flatpages de Django.
-
-Si vous êtes en production, vous devez changer le site de base
-(« example.com ») par le site de celcatsanitizer.
-
-Vous devez ensuite rajouter les pages /a-propos/ et /contact/.
-
-Vous pouvez effectuer tout ça à partir de l’interface d’administration
-de Django.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..3c63b61
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,13 @@
+celcatsanitizer
+===============
+La documentation de celcatsanitizer se trouve dans le dossier
+``Documentation/``. Il est possible de construire la documentation à
+l’aide de Sphinx_ en exécutant la commande ``make html`` dans le
+dossier ``Documentation/``.
+
+Il est possible de retrouver une copie en ligne de cette documentation
+à l’adresse suivante :
+
+    https://www.pa1ch.fr/projets/celcatsanitizer
+
+.. _Sphinx: http://www.sphinx-doc.org/