package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type

Management of the documentation environment.

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

type t
type named_root = string * Fs.Directory.t
type roots = {
  1. page_roots : named_root list;
  2. lib_roots : named_root list;
  3. current_lib : named_root option;
    (*

    The current -L.

    *)
  4. current_package : named_root option;
    (*

    The current -P.

    *)
  5. 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.

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

Helpers for creating xref2 env.

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.

Initialize the environment for linking the given module.

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

Initialize the environment for the given page.

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

Initialize the environment for the given implementation.

Initialize the environment for the given implementation.

val build_env_for_reference : t -> Odoc_xref2.Env.t

Initialize the environment for a reference.

val 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.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct