package odoc

Overview
Docs

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

T

Thomas Refis <trefis@janestreet.com>
D

David Sheets <sheets@alum.mit.edu>
L

Leo White <leo@lpw25.net>
Anton Bachin
J

Jon Ludlam <jon@recoil.org>
J

Jules Aguillon <juloo.dsi@gmail.com>
L

Lubega Simon <lubegasimon73@gmail.com>

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.odoc/Odoc_odoc/Compile/index.html

Module `Odoc_odoc.Compile`

type parent_cli_spec =

| CliParent of string
| CliPackage of string
| CliNoparent

Produces .odoc files out of .cm{i,t,ti} or .mld files.

val compile : 
  resolver:Resolver.t ->
  parent_cli_spec:parent_cli_spec ->
  hidden:bool ->
  children:string list ->
  output:Fs.File.t ->
  warnings_options:Odoc_model.Error.warnings_options ->
  Fs.File.t ->
  (unit, [> Or_error.msg ]) Or_error.result