jon.recoil.org
this repo has no description
1(*
2 * Copyright (c) 2016 Thomas Refis <trefis@janestreet.com>
3 *
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 *)
16
17module Html = Tyxml.Html
18
19(** Supported languages for printing code parts. *)
20
21(** {1 Page creator} *)
22
23val make :
24 config:Config.t ->
25 url:Odoc_document.Url.Path.t ->
26 header:Html_types.flow5_without_header_footer Html.elt list ->
27 breadcrumbs:Types.breadcrumbs ->
28 sidebar:Html_types.div_content Html.elt list option ->
29 toc:Types.toc list ->
30 uses_katex:bool ->
31 resources:Odoc_extension_registry.resource list ->
32 assets:Odoc_extension_registry.asset list ->
33 Html_types.div_content Html.elt list ->
34 Odoc_document.Renderer.page list ->
35 Odoc_document.Renderer.page
36(** [make ?theme_uri (body, children)] calls "the page creator" to turn [body]
37 into an [[ `Html ] elt]. If [theme_uri] is provided, it will be used to
38 locate the theme files, otherwise the HTML output directory is used. *)
39
40val make_src :
41 config:Config.t ->
42 url:Odoc_document.Url.Path.t ->
43 breadcrumbs:Types.breadcrumbs ->
44 header:Html_types.flow5_without_header_footer Html.elt list ->
45 sidebar:Html_types.div_content Html.elt list option ->
46 string ->
47 Html_types.div_content Html.elt list ->
48 Odoc_document.Renderer.page
49(** [make ?theme_uri (body, children)] calls "the page creator" to turn [body]
50 into an [[ `Html ] elt]. If [theme_uri] is provided, it will be used to
51 locate the theme files, otherwise the HTML output directory is used. *)