Module `Odoc_odoc.Resolver`Source

Management of the documentation environment.

This is the module which does the link between packages, directories and Odoc_xref2's needs.

Sourcetype t

Sourcetype named_root = string * Fs.Directory.t

Sourcetype roots = {

page_roots : named_root list;
lib_roots : named_root list;
current_lib : named_root option;
(*
The current -L.
*)
current_package : named_root option;
(*
The current -P.
*)
current_dir : Fs.Directory.t;
(*
Directory containing the output for the current unit.
*)

}

val create : 
  important_digests:bool ->
  directories:Fs.Directory.t list ->
  open_modules:string list ->
  roots:roots option ->
  t

Prepare the environment for a given list of include directories, page roots and library roots.

parameter important_digests
indicate whether digests should be compared when odoc_xref2 tries to lookup or fetch a unit. It defaults to true.

Sourceval lookup_page : t -> string -> Odoc_model.Lang.Page.t option

Helpers for creating xref2 env.

Source

val build_compile_env_for_unit : 
  t ->
  Odoc_model.Lang.Compilation_unit.t ->
  Odoc_xref2.Env.t

Initialize the environment for compiling the given module.

Source

val build_link_env_for_unit : 
  t ->
  Odoc_model.Lang.Compilation_unit.t ->
  Odoc_xref2.Env.t

Initialize the environment for linking the given module.

Sourceval build_env_for_page : t -> Odoc_model.Lang.Page.t -> Odoc_xref2.Env.t

Initialize the environment for the given page.

Source

val build_compile_env_for_impl : 
  t ->
  Odoc_model.Lang.Implementation.t ->
  Odoc_xref2.Env.t

Initialize the environment for the given implementation.

Source

val build_link_env_for_impl : 
  t ->
  Odoc_model.Lang.Implementation.t ->
  Odoc_xref2.Env.t

Initialize the environment for the given implementation.

Sourceval build_env_for_reference : t -> Odoc_xref2.Env.t

Initialize the environment for a reference.

Sourceval resolve_import : t -> string -> Odoc_model.Root.t option

Similar to Odoc_xref2.Env.lookup_root_module but save work by loading only the root. Only used when resolving imports, which are needed for the link-deps command.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/odoc.odoc/Odoc_odoc/Resolver/index.html

Module `Odoc_odoc.Resolver`Source

package odoc

Install

Dune Dependency

Authors

Maintainers

Sources

doc/odoc.odoc/Odoc_odoc/Resolver/index.html

Module Odoc_odoc.ResolverSource

Module `Odoc_odoc.Resolver`Source