\[\definecolor{red}{RGB}{255,0,0} \definecolor{purple}{RGB}{154,0,154} \definecolor{blue}{RGB}{0,0,224} \definecolor{green}{RGB}{0,187,0} \definecolor{yellow}{RGB}{255,234,0} \definecolor{pink}{RGB}{255,77,166} \definecolor{orange}{RGB}{255,120,0} \definecolor{grey}{RGB}{128,128,128} \definecolor{black}{RGB}{0,0,0} \definecolor{white}{RGB}{255,255,255} \newcommand{\R}{\_mathbb{R}} \newcommand{\Z}{\mathbb{Z}} \newcommand{\N}{\mathbb{N}} \newcommand{\P}{\mathbb{P}} \newcommand\given[1][]{\:#1\vert\:} \DeclareMathOperator{\Corr}{Corr} \DeclareMathOperator{\Cov}{Cov}\]

Contribuer

Principe

Le contenu de ce site est généré à partir de fichiers .rst permettant :

  • De ne pas avoir à toucher à la mise en page
  • De pouvoir écrire des formules en LaTeX
  • De pouvoir afficher du code formaté avec Pygments
  • De pouvoir, par exemple, afficher le schéma matplotlib correspondant au code qui l’a généré

Le format .rst (reStructuredText) est décrit rapidement dans ce Quickref

Editer les pages

Vous pouvez directement éditer les pages via Github (et effectuer une Pull Request) afin de modifier les pages existantes mais vous pouvez aussi proposer d’en ajouter.

Toute correction, ajout ou modification est la bienvenue.

Vous pouvez aussi proposer des modifications du template Sphinx pour améliorer l’ergonomie du site.

Guidelines

  • Le contenu doit être en Français mais nous acceptons les termes communs en anglais comme « Data Science », « features », « kernels »… tant qu’ils sont définis dans Les Bases.
  • Une page sur une notion doit respecter une certaine forme:
    • Elle doit commencer par les “requirements”: c’est à dire ce que le lecteur a besoin de connaitre avant de pouvoir comprendre cette page. Si possible renvoyer vers d’autres pages du site dans « Les Bases »
    • Elle doit, dans un premier temps, vulgariser le concept, il s’agit d’expliquer concrètement à quoi sert ce modèle et comment il marche. Dans un deuxième temps, la page expliquera en détails son fonctionnement.
    • Elle doit présenter un exemple visuel (avec du code Python)

Possibilités offertes par Sphinx

Pour voir comment réaliser les exemples suivants, il vous suffit d’éditer le code source de cette page sur Github par exemple.

Afficher du code avec coloration syntaxique

Cette option utilise Pygments.

1
2
3
for e in bb.stream_single():
   print(e)
print("Hello world")

Afficher des formules mathématiques

Cette option utilise MathJax (et peut-être KaTeX quand ce sera assez mature). Et oui il est aussi possible de colorer ses formules pour ajouter en compréhension :D

\[\color{red} X_{\color{purple} k} \color{black} = \color{blue} \frac{1}{N} \sum_{n=0}^{N-1} \color{green}x_n \color{orange} e^{\mathrm{i} \color{pink} 2\pi \color{purple}k \color{blue} \frac{n}{N}}\]

To find the energy at a particular frequency, spin your signal around a circle at that frequency, and average a bunch of points along that path.

Afficher le schéma créé par du code Python

Oui oui ! Ce schéma est bien généré à la volée à partir de code Python écrit dans le fichier ReST source de cette page !

(Source code, png, hires.png, pdf)

_images/contribuer-1.png