package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml documentation generator

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (3)

Authors

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.latex/Odoc_latex/Raw/index.html

Module `Odoc_latex.Raw`

Raw latex primitives:

macro and environment definitions
text escaping

type pr = 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