package odoc

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

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.

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