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 ISC License Edit opam file Versions (3)

Authors

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.odoc/Odoc_odoc/Depends/index.html

Module `Odoc_odoc.Depends`

Computes the dependencies required for each step of the pipeline to work correctly on a given input.

module Compile : sig ... end

val for_compile_step : Fs.File.t -> Compile.t list

Takes a .cm{i,t,ti} file and returns the list of its dependencies.

val for_rendering_step : 
  Fs.Directory.t ->
  (Odoc_model.Root.t list, [> Or_error.msg ]) Or_error.result

Takes the directory where the .odoc files of a given package are stored and returns the list of roots that need to be in odoc's load path to render these .odoc files.