Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 2.25 KB
Raw

Contribuer aux supports

Fonctionnement du dépôt

Le site web et les notebooks sont construits à partir de Quarto. Le site web est le format par défaut, les notebooks sont construits par intégration continue.

En supposant que l'environnement Python est fonctionnel (cf. ci-dessous), le site web dans son ensemble peut être construit avec la commande suivante

# pour les utilisateurs du sspcloud
quarto preview --port 5000 --host 0.0.0.0

# hors du sspcloud
quarto preview

Pour ne faire un render que d'une fiche, il est possible de modifier à la main la section render du fichier _quarto.yml. Supprimer la liste des fichiers sauf les **/introductions.qmd et la fiche désirée. N'oubliez pas de restaurer la version d'origine du quarto.yml avant de faire la pull request !

Pour visualiser le notebook qui sera généré à l'issue des modifications, la commande à exécuter est la suivante :

quarto render chemin_du_fichier/fichier.qmd --to ipynb

puis ouvrir le .ipynb obtenu.

La correction peut être prévisualisée de la manière suivante :

quarto render --execute -M echo:true

puis ouvrir le .ipynb obtenu.

Aucun output ne doit être committé, seuls les fichiers sources .qmd. Toutes les sorties (fichiers .png, .html, .ipynb, etc.) sont générées par le biais de scripts automatisés qui tournent à chaque commit sur le dépôt linogaliana/python-datascientist.

Mise en place de l'environnement pour tester les exemples

Pour les contributeurs ayant un accès au SSP Cloud, ces commandes suffisent pour avoir l'environnement minimal nécessaire pour construire en local le site web.

# Sur le SSPCloud
pip install -r requirements.txt
./requirements.sh

Pour les contributeurs hors de cet environnement (dommage !), il est nécessaire en premier lieu d'avoir les éléments suivants :

  • Une version récente de Quarto, a minima la 1.3.450.
  • Jupyter et un outil de gestion des environnements Python (miniconda par exemple).

L'installation de l'environnement minimal pour reproduire les exemples peut être fait sur la base d'un trial and error en attendant la mise à disposition d'un fichier adéquat (pip freeze ne fournit pas un fichier satisfaisant)