package odoc

  1. Overview
  2. Docs
On This Page
  1. Page creator
package odoc
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Odoc_html.Html_pageSource

Sourcemodule Html = Tyxml.Html

Supported languages for printing code parts.

Page creator

Sourceval make : config:Config.t -> url:Odoc_document.Url.Path.t -> header:Html_types.flow5_without_header_footer Html.elt list -> breadcrumbs:Types.breadcrumbs -> sidebar:Html_types.div_content Html.elt list option -> toc:Types.toc list -> uses_katex:bool -> Html_types.div_content Html.elt list -> Odoc_document.Renderer.page list -> Odoc_document.Renderer.page

make ?theme_uri (body, children) calls "the page creator" to turn body into an [ `Html ] elt. If theme_uri is provided, it will be used to locate the theme files, otherwise the HTML output directory is used.

Sourceval make_src : config:Config.t -> url:Odoc_document.Url.Path.t -> breadcrumbs:Types.breadcrumbs -> header:Html_types.flow5_without_header_footer Html.elt list -> sidebar:Html_types.div_content Html.elt list option -> string -> Html_types.div_content Html.elt list -> Odoc_document.Renderer.page

make ?theme_uri (body, children) calls "the page creator" to turn body into an [ `Html ] elt. If theme_uri is provided, it will be used to locate the theme files, otherwise the HTML output directory is used.

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