package odoc
OCaml documentation generator
Install
Dune Dependency
Authors
Maintainers
Sources
odoc-2.1.1.tbz
sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd
sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91
doc/odoc.odoc/Odoc_odoc/Odoc_file/index.html
Module Odoc_odoc.Odoc_file
Load and save .odoc
and .odocl
files.
type content =
| Page_content of Odoc_model.Lang.Page.t
| Unit_content of Odoc_model.Lang.Compilation_unit.t
Either a page or a module.
Serialization
val save_page :
Fs.File.t ->
warnings:Odoc_model.Error.t list ->
Odoc_model.Lang.Page.t ->
unit
Save a page. The page-
prefix is added to the file name if missing.
val save_unit :
Fs.File.t ->
warnings:Odoc_model.Error.t list ->
Odoc_model.Lang.Compilation_unit.t ->
unit
Save a module.
Deserialization
val load : Fs.File.t -> (t, [> Or_error.msg ]) Or_error.result
Load an .odoc
file.
val load_root :
Fs.File.t ->
(Odoc_model.Root.t, [> Or_error.msg ]) Or_error.result
Only load the root. Faster than load
, used for looking up imports.
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>
On This Page