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/Resolver/index.html

Module Odoc_odoc.ResolverSource

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 = {
  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.

    *)
}
Sourceval 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.

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

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

Initialize the environment for the given page.

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

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.