package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml documentation generator

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (3)

Authors

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.html/Odoc_html/Tree/index.html

Module `Odoc_html.Tree`

module Html = Tyxml.Html

Supported languages for printing code parts.

type uri =

| Absolute of string
| Relative of Odoc_document.Url.Path.t option
(*
The type for absolute and relative URIs. The relative URIs are resolved using the HTML output directory as a target.
*)

Page creator

val make : 
  ?theme_uri:uri ->
  ?support_uri:uri ->
  indent:bool ->
  url:Odoc_document.Url.Path.t ->
  header:Html_types.flow5_without_header_footer Html.elt list ->
  toc:Html_types.flow5 Html.elt list ->
  string ->
  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.

val open_details : bool ref

Whether <details> tags should be opened by default or not. Default is true.

On This Page

Page creator