jon.recoil.org

Module Odoc_latex.RawSource

Raw latex primitives:

Helper types

Sourcetype 'a with_options = ?options:Odoc_latex.Raw.pr list -> 'a
Sourcetype ('a, 'b) tr = 'a Fmt.t -> 'b Fmt.t
Sourcetype 'a t = ('a, 'a) Odoc_latex.Raw.tr
Sourcemodule Escape : sig ... end
Sourceval rightarrow : Odoc_latex.Raw.pr
Sourceval label : string Fmt.t
Sourceval verbatim : string Fmt.t
Sourceval pageref_star : string Fmt.t
Sourceval hyperref : string -> 'a Odoc_latex.Raw.t
Sourceval href : string -> 'a Odoc_latex.Raw.t
Sourceval ref : string Fmt.t
Sourceval url : string Fmt.t
Sourceval footnote : string Fmt.t
Sourceval subscript : 'a Odoc_latex.Raw.t
Sourceval superscript : 'a Odoc_latex.Raw.t
Sourceval section : 'a Odoc_latex.Raw.t
Sourceval subsection : 'a Odoc_latex.Raw.t
Sourceval subsubsection : 'a Odoc_latex.Raw.t
Sourceval paragraph : 'a Odoc_latex.Raw.t
Sourceval enumerate : 'a Odoc_latex.Raw.t
Sourceval itemize : 'a Odoc_latex.Raw.t
Sourceval description : ('a, ('a * 'a) list) Odoc_latex.Raw.tr
Sourceval small_table : ('a, Odoc_latex.Types.alignment list option * 'a list list) Odoc_latex.Raw.tr
Sourceval input : Fpath.t Fmt.t
Sourceval includegraphics : 'a Odoc_latex.Raw.t

Required OCaml-specific primitives

All the macro should be implemented as "ocaml"-suffixed macro in the latex preamble

Sourceval inline_code : 'a Odoc_latex.Raw.t

Code block customization

Sourceval code_fragment : 'a Odoc_latex.Raw.t
Sourceval code_block : 'a Odoc_latex.Raw.t

Package-dependent primitives

Sourceval indent : 'a Odoc_latex.Raw.t

expected to be implemented with changepage/adjustwidth

Sourceval ocamltabular : column_desc:Odoc_latex.Raw.pr -> 'a Odoc_latex.Raw.t

Any tabular implementation that works well with at most 10 rows

Tags

Sourceval ocamltag : string -> 'a Odoc_latex.Raw.t

tag (e.g keyword, type-var, ...) are rendered to

\ocamltag{tagname}{content}

Math mode

Sourceval math : string Fmt.t
Sourceval equation : string Fmt.t