package odoc

  1. Overview
  2. Docs
OCaml documentation generator

Install 

dune-project
 Dependency

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

Authors

  1. T
    Thomas Refis <trefis@janestreet.com>
  2. D
    David Sheets <sheets@alum.mit.edu>
  3. L
    Leo White <leo@lpw25.net>
  4. Anton Bachin
  5. J
    Jon Ludlam <jon@recoil.org>
  6. J
    Jules Aguillon <juloo.dsi@gmail.com>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>

Maintainers

  1. J
    Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz
sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd
sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.document/Odoc_document/Renderer/index.html

Module Odoc_document.Renderer

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 -> unit
type 'a t = {
  1. name : string;
  2. render : 'a -> Types.Page.t -> page;
  3. files_of_url : Url.Path.t -> Fpath.t list;
}
val document_of_page : syntax:syntax -> Odoc_model.Lang.Page.t -> Types.Page.t
val document_of_compilation_unit : syntax:syntax -> Odoc_model.Lang.Compilation_unit.t -> Types.Page.t