package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml Documentation Generator

Install

Dune Dependency

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

Authors

Maintainers

Sources

odoc-3.0.0.tbz

sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b

sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6

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

Module `Odoc_odoc.Compile`Source

Sourcetype package_spec = {

package : string;
output : Fpath.t;

}

Sourcetype parent_spec = {

parent : string option;
children : string list;
output : Fpath.t;

}

Sourcetype parent_id_spec = {

parent_id : string;
output_dir : string;

}

Sourcetype cli_spec =

| CliNoParent of Fpath.t
| CliPackage of package_spec
| CliParent of parent_spec
| 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.

Source

val resolve_imports : 
  Resolver.t ->
  Odoc_model.Lang.Compilation_unit.Import.t list ->
  Odoc_model.Lang.Compilation_unit.Import.t list

Source

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

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

Sourceval mk_id : string -> Odoc_model.Paths.Identifier.ContainerPage.t option

Source

val path_of_id : 
  string ->
  Odoc_model.Paths.Identifier.ContainerPage.t option ->
  Fpath.t

Source

val compile : 
  resolver:Resolver.t ->
  hidden:bool ->
  cli_spec:cli_spec ->
  warnings_options:Odoc_model.Error.warnings_options ->
  short_title:string option ->
  Fpath.t ->
  (unit, [> Or_error.msg ]) Or_error.result

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

package odoc

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module Odoc_odoc.CompileSource

Module `Odoc_odoc.Compile`Source