package odoc

  1. Overview
  2. Docs
OCaml documentation generator

Install

Dune Dependency

Authors

Maintainers

Sources

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

doc/odoc.odoc/Odoc_odoc/Html_fragment/index.html

Module Odoc_odoc.Html_fragment

Produces html fragment files from a mld file.

val from_mld : xref_base_uri:string -> resolver:Resolver.t -> output:Fs.File.t -> warnings_options:Odoc_model.Error.warnings_options -> Fs.File.t -> (unit, [> Or_error.msg ]) Or_error.result

from_mld ~xref_base_uri ~resolver ~output input parses the content of the input file as a documentation page (i.e. the ocamldoc syntax), generates the equivalent HTML representation and writes the result into the output file. The produced file is an HTML fragment that can be embedded into other documents.

Cross-reference resolution uses the provided xref_base_uri to locate docset packages.

OCaml

Innovation. Community. Security.