包括ocamldoc的数学方程式

时间:2016-09-05 13:21:22

标签: documentation latex ocaml

我想在使用ocamldoc生成的文档中包含方程式。我正在使用一个小(蝙蝠)脚本:

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识别的公式?

1 个答案:

答案 0 :(得分:2)

您可以使用target specific formatting

{%latex: ... %}

请注意,通常ocamldoc文档会呈现为HTML而不是PDF。所以我不会利用该指令和/或关心HTML输出。对于子/超级脚本,ocamldoc language直接支持它们。对于HTML特定输出,只需执行

{%html: ... %}