Source file targets.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
(*
 * Copyright (c) 2014 Leo White <leo@lpw25.net>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

open StdLabels
open Or_error

let of_odoc_file ~env ~output:root_dir input =
  Root.read input >>= function
  | { file = Page page_name; package; _ } ->
      let pkg_dir = Fs.Directory.of_string package in
      let directory = Fs.Directory.append root_dir pkg_dir in
      let file = Fs.File.create ~directory ~name:(page_name ^ ".html") in
      Ok [file]
  | { file = Compilation_unit _; _ } ->
      Compilation_unit.load input >>= fun unit ->
      let env = Env.build env (`Unit unit) in
      Odoc_xref.resolve (Env.resolver env) unit >>=
      Odoc_xref.expand (Env.expander env) >>= fun odoctree ->
      let root = Compilation_unit.root odoctree in
      let package = root.package in
      let targets = Odoc_html.Targets.unit ~package odoctree in
      (* CR-someday trefis: have [List_targets] return a tree instead of
         postprocessing. *)
      Ok (
        List.map targets ~f:(fun path ->
          let directory = Fs.Directory.(append root_dir (of_string path)) in
          Fs.File.create ~directory ~name:"index.html"
        ))

let index ~output:_ _ = []