Comment écrire des formules mathématiques pour la documentation de Rust?

Question

Je voudrais écrire une formule mathématique dans la documentation de Rust pour ma caisse. On dirait qu'il est un soutien de base de LATEX au moins power œuvres:

/// $ 2^8 $ 

est rendu comme:

Je voudrais utiliser une fraction dans ma formule, mais malheureusement, cela ne fonctionne pas:

/// $ \frac{x}y $ 

Answer 1

On dirait ther e est le support de base de LaTeX

Pas tout à fait. Il existe un support pour Markdown, pas LaTeX. Stack Overflow prend également en charge Markdown, mais une saveur différente. Par exemple: a^b => a^b, mais a<sup>b</sup> => a ^b. Markdown n'a pas de support pour LaTeX arbitraire. En effet, votre exemple:

/// Hi 
/// 
/// $ 2^8 $ 
pub fn what() { 

} 

Génère quelque chose qui contient encore le $:

La meilleure chose pourrait être de générer des images pré-rendus et les inclure dans la documentation de votre place, mais an open issue semble indiquer que cela n'est actuellement pas possible, sauf si vous hébergez les images ailleurs. Il y avait même an issue to support MathJax in rustdoc, mais c'était fermé.

Answer 2

Vous pouvez le faire fonctionner avec MathJax et rustdoc--html-in-header pour transmettre un lien vers le tag de script dont il a besoin. C'est très hacky, et ne fonctionnera pas sur docs.rs, mais cela peut fonctionner si vous hébergez vos propres docs.