jon.recoil.org

Module Odoc_html.Html_shellSource

module Html := Tyxml.Html
Sourcetype page_data = {
  1. url : Odoc_document.Url.Path.t;
  2. header : Html_types.flow5_without_header_footer Html.elt list;
  3. preamble : Html_types.flow5_without_header_footer Html.elt list;
  4. content : Html_types.div_content Html.elt list;
  5. breadcrumbs : Odoc_html.Types.breadcrumbs;
  6. toc : Odoc_html.Types.toc list;
  7. sidebar : Html_types.div_content Html.elt list option;
  8. sidebar_data : Odoc_document.Sidebar.t option;
  9. uses_katex : bool;
  10. source_anchor : string option;
  11. resources : Odoc_extension_registry.resource list;
  12. assets : Odoc_extension_registry.asset list;
  13. children : Odoc_document.Renderer.page list;
}

Data for assembling a documentation page. All HTML fragments are pre-rendered by the generator.

Sourcetype src_page_data = {
  1. url : Odoc_document.Url.Path.t;
  2. header : Html_types.flow5_without_header_footer Html.elt list;
  3. breadcrumbs : Odoc_html.Types.breadcrumbs;
  4. sidebar : Html_types.div_content Html.elt list option;
  5. sidebar_data : Odoc_document.Sidebar.t option;
  6. title : string;
  7. content : Html_types.div_content Html.elt list;
}

Data for assembling a source code page.

Sourcemodule type S = sig ... end

The interface that a page shell must implement.

Shell Registry

Sourceval register : (module Odoc_html.Html_shell.S) -> unit

Register a shell. Shells are identified by name.

Sourceval find : string -> (module Odoc_html.Html_shell.S) option

Look up a shell by name.

Sourceval list_shells : unit -> string list

List all registered shell names.

Sourceval default : unit -> (module Odoc_html.Html_shell.S)

Return the default shell ("default"). Raises if no default is registered.