Включить математическое уравнение с ocamldoc

Question

Я хотел бы включить уравнения в документацию, созданную с помощью ocamldoc. Я использую небольшой (BAT) скрипт:

ocamldoc -latex maths.ml 
pdflatex ocamldoc.out 

где maths.ml содержит следующие комментарии:

(** "Given a list of indices \\(v \\) and a vector of weights \f$ w \f$, this returns $ sum_iw_{v_i} $"*) 
let dot_product indices weights = [...] 

Однако, единственное, что производится в файле PDF находится:

val dot_product : int list -> float array -> float 
"Given a list of indices \\(v \\) and a vector of weights \f$ w \f$, this returns $ sum_iw_ 
$" 

Я пробовал различные способы указать уравнения ($, \ f $, \(), но ни один из них не был идентифицирован. Есть ли конкретный способ указания уравнений для их распознавания ocamldoc?

Answer 1

Вы можете использовать target specific formatting:

{%latex: ... %} 

Обратите внимание, что в общем ocamldoc документации оказана HTML, а не PDF-файлов. Поэтому я не буду использовать эту директиву и/или заботиться о выходе HTML. Для суб/супер-скриптов ocamldoc language поддерживает их напрямую. Для конкретных HTML-данных просто выполните

{%html: ... %}