package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type

Raw latex primitives:

  • macro and environment definitions
  • text escaping
type pr = Stdlib.Format.formatter -> unit

Helper types

type 'a with_options = ?options:pr list -> 'a
type ('a, 'b) tr = 'a Fmt.t -> 'b Fmt.t
type 'a t = ('a, 'a) tr
module Escape : sig ... end
val break : Types.break_hierarchy Fmt.t
val rightarrow : pr
val label : string Fmt.t
val verbatim : string Fmt.t
val pageref_star : string Fmt.t
val hyperref : string -> 'a t
val href : string -> 'a t
val ref : string Fmt.t
val url : string Fmt.t
val footnote : string Fmt.t
val emph : 'a t
val bold : 'a t
val subscript : 'a t
val superscript : 'a t
val section : 'a t
val subsection : 'a t
val subsubsection : 'a t
val paragraph : 'a t
val enumerate : 'a t
val itemize : 'a t
val description : ('a, ('a * 'a) list) tr
val item : 'a t with_options
val small_table : ('a, 'a list list) tr
val input : Fpath.t Fmt.t

Required OCaml-specific primitives

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

val inline_code : 'a t

Code block customization

val code_fragment : 'a t
val code_block : 'a t

Package-dependent primitives

val indent : 'a t

expected to be implemented with changepage/adjustwidth

val ocamltabular : column_desc:pr -> 'a t

Any tabular implementation that works well with at most 10 rows

Tags

val ocamltag : string -> 'a t

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

\ocamltag{tagname}{content}
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct