nit icon indicating copy to clipboard operation
nit copied to clipboard

Supporter le math mode de TeX dans la doc

Open xymus opened this issue 11 years ago • 3 comments

Le math mode de TeX permet d'écrire des formules mathématique en ascii. Elles peuvent être compilées vers du PS/PDF avec les outils LaTeX mais aussi vers du web avec gladtex ou différents scripts JavaScript. Pour les outils, voir http://johnmacfarlane.net/pandoc/README.html#math.

Ce serait à supporter par la nitdoc pour permettre de documenter les aspects mathématiques d'une méthode.

xymus avatar Sep 30 '14 03:09 xymus

pour permettre de documenter les aspects mathématiques d'une méthode

Avec modération alors. Rien ne vaut un bon vieux nitunit.

Morriar avatar Sep 30 '14 03:09 Morriar

Autant pour gerer du markdown en tant que markdown pour du nitkiwiki ou du paninitdoc OK, autant pour de l'autodoc, j'suis pas forcément fan, et comme le dit Alex, il serait souvent plus judicieux d'exprimer des formules en nit.

privat avatar Sep 30 '14 13:09 privat

Dans certain cas c'est louche de documenter une méthode par du code Nit:

  • Pour décrire la complexité de la méthode, ce n'est pas du code mais des math.
  • Pour des méthodes d'opérations mathématiques, tel que des statistiques. Si tu veux l'implémentation Nit tu peux regarder le code Nit. Dans la doc tu aurais l'occasion d'associer cette méthode avec sa forme mathématique.

xymus avatar Sep 30 '14 15:09 xymus