#!/usr/bin/python3
#-*- coding: utf8 -*-

# @author : Sébastien LOZANO

# Source pour l'écriture d'un REAMDE en mardown : https://www.makeareadme.com/ 
# Génère la page d'accueil de la documentation pdoc3

"""
    # DIU EIL 2020/2022 - BLOC1

    Le projet consiste à transférer les données d’un fichier csv dans un document HTML
    permettant d’en consulter le contenu.

    Cette documentation a été générée avec le paquet **pdoc3**.

    Utiliser le **package manager** [pip3](https://pip.pypa.io/en/stable/){:target="_blank"} pour l'installer.

    ```bash
    pip3 install pdoc3
    ```

    ## Installation et utilisation
    
    La procédure a été testé sous **Linux** uniquement.

    * Télécharger cette <a href="../../python_prod.zip"> archive zip</a>.
    
    * Décompresser l'archive.

    * À la racine du projet, lancer le script python **bloc1_generate_files.py**.

    ```bash
    python3 bloc1_generate_files.py
    ```
    
    ## Notes

    Les fichiers de la documentation sont générés à la racine du projet dans le dossier **docs**.

    Les fichiers HTML sont générés à la racine du projet dans le dossier **pagesWeb**.

    Le script met  environ **22 minutes** à créer l'ensemble des fichiers.

    Les sous-modules suivants contiennent notamment les fonctions demandées.

    Deux versions pour le fichier HTML avec filtre par formulaire :

    * **Version 1** : L'ensemble des lignes du tableau est généré dans le DOM puis cachées, l'affichage est ensuite géré dynamiquement via des scripts javascript mais l'ensemble des lignes reste dans le DOM.
    * **Version 2** : Un tableau javascript est générée via python, on gère ensuite le DOM et donc l'affichage dynamiquement via javascript.
"""
pass