jon.recoil.org
this repo has no description
1module Id : sig
2 type t
3 val to_fpath : t -> Fpath.t
4 val of_fpath : Fpath.t -> t
5 val to_string : t -> string
6end
7
8val index_filename : string
9val sidebar_filename : string
10
11val odoc : Bos.Cmd.t ref
12val odoc_md : Bos.Cmd.t ref
13
14type compile_deps = { digest : Digest.t; deps : (string * Digest.t) list }
15val compile_deps : Fpath.t -> (compile_deps, [> `Msg of string ]) result
16val classify : Fpath.t list -> (string * string list) list
17val compile_impl :
18 output_dir:Fpath.t ->
19 input_file:Fpath.t ->
20 includes:Fpath.set ->
21 parent_id:Id.t ->
22 source_id:Id.t ->
23 unit
24val compile :
25 output_dir:Fpath.t ->
26 input_file:Fpath.t ->
27 includes:Fpath.set ->
28 warnings_tag:string option ->
29 parent_id:Id.t ->
30 ignore_output:bool ->
31 unit
32val compile_md :
33 output_dir:Fpath.t -> input_file:Fpath.t -> parent_id:Id.t -> unit
34
35val compile_asset : output_dir:Fpath.t -> name:string -> parent_id:Id.t -> unit
36
37val link :
38 ?ignore_output:bool ->
39 custom_layout:bool ->
40 input_file:Fpath.t ->
41 ?output_file:Fpath.t ->
42 docs:(string * Fpath.t) list ->
43 libs:(string * Fpath.t) list ->
44 includes:Fpath.t list ->
45 warnings_tags:string list ->
46 ?current_package:string ->
47 unit ->
48 unit
49
50val compile_index :
51 ?ignore_output:bool ->
52 output_file:Fpath.t ->
53 ?occurrence_file:Fpath.t ->
54 json:bool ->
55 roots:Fpath.t list ->
56 simplified:bool ->
57 wrap:bool ->
58 unit ->
59 unit
60
61val sidebar_generate :
62 ?ignore_output:bool ->
63 output_file:Fpath.t ->
64 json:bool ->
65 Fpath.t ->
66 unit ->
67 unit
68
69val html_generate :
70 output_dir:string ->
71 ?sidebar:Fpath.t ->
72 ?ignore_output:bool ->
73 ?search_uris:Fpath.t list ->
74 ?remap:Fpath.t ->
75 ?as_json:bool ->
76 ?home_breadcrumb:string ->
77 input_file:Fpath.t ->
78 unit ->
79 unit
80
81val html_generate_asset :
82 output_dir:string ->
83 ?ignore_output:bool ->
84 ?home_breadcrumb:string ->
85 input_file:Fpath.t ->
86 asset_path:Fpath.t ->
87 unit ->
88 unit
89
90val html_generate_source :
91 output_dir:string ->
92 ?ignore_output:bool ->
93 source:Fpath.t ->
94 ?sidebar:Fpath.t ->
95 ?search_uris:Fpath.t list ->
96 ?as_json:bool ->
97 ?home_breadcrumb:string ->
98 input_file:Fpath.t ->
99 unit ->
100 unit
101
102val support_files : Fpath.t -> string list
103
104val count_occurrences : input:Fpath.t list -> output:Fpath.t -> unit