From 0eeba2b335807c8c19c2dbfd0463aa4df1375d0e Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Sun, 15 Apr 2018 21:46:47 +0200 Subject: doc: Début de la nouvelle documentation avec Sphinx --- Documentation/index.rst | 74 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 Documentation/index.rst (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst new file mode 100644 index 0000000..92ad7b7 --- /dev/null +++ b/Documentation/index.rst @@ -0,0 +1,74 @@ +=============== +celcatsanitizer +=============== + +Présentation de celcatsanitizer +=============================== +Qu’est-ce que celcatsanitizer ? +------------------------------- + +celcatsanitizer est un outil basé sur Django_ permettant de reformater +les emplois du temps générés par Celcat. + +Les emplois du temps, accessibles à travers un navigateur web, +deviennent ainsi plus lisibles (notamment sur les appareils mobiles), +plus rapides à charger et plus légères. + +Les pages générées par celcatsanitizer ont étées conçues pour être les +plus légères possibles, tout en restant lisibles et fournies en +informations. Les pages peuvent être chargées sans CSS, et peuvent +êtres rendues sans problèmes par une large gamme de navigateurs. + +celcatsanitizer est aussi capable d’exporter les emplois du temps en +ICS_. + +Le parseur de celcatsanitizer est optimisé pour les emplois du temps +de l’Université Paul Sabatier, mais il est possible de le modifier. + +Vous pouvez trouver une instance de celcatsanitizer à l’adresse +https://edt.pa1ch.fr/. Cette instance utilise les emplois du temps de +l’Université Paul Sabatier. + +.. _Django: https://www.django-project.com/ +.. _ICS: https://fr.wikipedia.org/wiki/ICalendar + +Qu’est-ce que n’est pas celcatsanitizer ? +----------------------------------------- +celcatsanitizer n’est pas capable de produire un emploi du temps de +lui-même, seulement de reformater ceux produits par Celcat. + +Notes importantes +----------------- +Affiliation +``````````` +celcatsanitizer est un projet mené par des étudiants. Il n’est soutenu +d’aucune manière par Celcat ou l’Université Paul Sabatier. + +Licence +``````` +celcatsanitizer est sous licence AGPL3_, ce qui signifie, entre +autres, que toute modification de son code source **doit** être +redistribuée. + +.. _AGPL3: https://www.gnu.org/licenses/agpl-3.0.fr.html + +Utilisation de celcatsanitizer +============================== + +.. toctree:: + :maxdepth: 2 + + usage/installation + usage/commands + usage/versions + +Développement +============= + +.. toctree:: + :maxdepth: 2 + + dev/contribute + dev/xml + dev/internals + dev/roadmap -- cgit v1.2.1 From b6e146c48fa3c25e419bc0458e423cbef3dee133 Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Sun, 22 Apr 2018 12:07:56 +0200 Subject: doc: documentation des commandes administratives --- Documentation/index.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index 92ad7b7..c9e0b2a 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -59,7 +59,10 @@ Utilisation de celcatsanitizer :maxdepth: 2 usage/installation - usage/commands + usage/commands/cleancourses + usage/commands/listtimetables + usage/commands/reparse + usage/commands/timetables usage/versions Développement -- cgit v1.2.1 From 1ca0575a0633d281b9dc2ca10b7c0ad2fded86a7 Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Sun, 22 Apr 2018 18:42:14 +0200 Subject: doc: finalisation --- Documentation/index.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index c9e0b2a..992db09 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -73,5 +73,4 @@ Développement dev/contribute dev/xml - dev/internals dev/roadmap -- cgit v1.2.1 From ea38d01d76f695d529284c841fe9ba7f441bad1b Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Mon, 23 Apr 2018 12:03:00 +0200 Subject: doc: corrections de grammaire --- Documentation/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/index.rst') diff --git a/Documentation/index.rst b/Documentation/index.rst index 992db09..e793dd2 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -12,7 +12,7 @@ les emplois du temps générés par Celcat. Les emplois du temps, accessibles à travers un navigateur web, deviennent ainsi plus lisibles (notamment sur les appareils mobiles), -plus rapides à charger et plus légères. +plus rapides à charger et plus légers. Les pages générées par celcatsanitizer ont étées conçues pour être les plus légères possibles, tout en restant lisibles et fournies en -- cgit v1.2.1