package odoc

  1. Overview
  2. Docs
OCaml Documentation Generator

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (5)

Authors

  1. Anton Bachin
  2. Daniel Bünzli
  3. D
    David Sheets <sheets@alum.mit.edu>
  4. J
    Jon Ludlam <jon@recoil.org>
  5. J
    Jules Aguillon <juloo.dsi@gmail.com>
  6. L
    Leo White <leo@lpw25.net>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>
  8. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>
  9. T
    Thomas Refis <trefis@janestreet.com>

Maintainers

  1. Daniel Bünzli
  2. J
    Jon Ludlam <jon@recoil.org>
  3. J
    Jules Aguillon <juloo.dsi@gmail.com>
  4. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>

Sources

odoc-3.2.1.tbz
sha256=d45eb125514839fd9ac27702bb4938d1b4f3b6978e9b16ab9673ea067245affc
sha512=3555386b4770a7caa8ec903683bde5ecdc41d5e57ffaee617d5da225c747bbd1e9c1d2677f4df97e96bbdfc69f580ea83b1b92b933ea40a436a658788b677bbc

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

Module Odoc_odoc.CompileSource

Sourcetype package_spec = {
  1. package : string;
  2. output : Fpath.t;
}
Sourcetype parent_spec = {
  1. parent : string option;
  2. children : string list;
  3. output : Fpath.t;
}
Sourcetype parent_id_spec = {
  1. parent_id : string;
  2. output_dir : string;
}
Sourcetype cli_spec =
  1. | CliNoParent of Fpath.t
  2. | CliPackage of package_spec
  3. | CliParent of parent_spec
  4. | CliParentId of parent_id_spec
Sourceval name_of_output : prefix:string -> Fs.File.t -> string

Compute the name of the page from the output file. Prefix is the prefix to remove from the filename.

Sourceval resolve_parent_page : Resolver.t -> string -> (Odoc_model.Paths.Identifier.ContainerPage.t * Odoc_model.Lang.Page.child list, [> Odoc_utils.msg ]) result

Parse and resolve a parent reference. Returns the identifier of the parent and its children as a list of reference.

Sourceval path_of_id : string -> Odoc_model.Paths.Identifier.ContainerPage.t option -> Fpath.t
Sourceval compile : resolver:Resolver.t -> hidden:bool -> cli_spec:cli_spec -> warnings_options:Odoc_model.Error.warnings_options -> short_title:string option -> Fpath.t -> (unit, [> Odoc_utils.msg ]) result

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