package odoc

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

Standard definition and types for all renderers

type syntax =
  1. | OCaml
  2. | Reason
val string_of_syntax : syntax -> string
type page = {
  1. filename : Fpath.t;
  2. content : Format.formatter -> unit;
  3. children : page list;
}
val traverse : f:(Fpath.t -> (Format.formatter -> unit) -> 'a) -> page list -> unit
type 'a t = {
  1. name : string;
  2. render : 'a -> Types.Document.t -> page list;
  3. extra_documents : 'a -> input -> syntax:syntax -> Types.Document.t list;
}
val document_of_page : syntax:syntax -> Odoc_model.Lang.Page.t -> Types.Document.t
val documents_of_source_tree : syntax:syntax -> Odoc_model.Lang.SourceTree.t -> Types.Document.t list
val document_of_compilation_unit : syntax:syntax -> Odoc_model.Lang.Compilation_unit.t -> Types.Document.t
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