ML-Module: doc_html Package: mldoc

Description

This is the HTML backend module used to convert MlDoC documents in HTML-4 (transitional) format. This html_of_tree function is used to convert the structure_block graph to HTML output.



Programming Interface
unit  ]  =  html_of_tree
~ds : structure_block ->
~options : html_options list ->
~sections : section_names list

The html_of_tree function needs three arguments:
Arguments

ds
This is the structure block tree previously generated with the atoms_of_ function family.
options
Several options can control the converting behaviour and the output. Available options:

HTML_single_doc of string Only create a single HTML file instead of a collection of files, each for one section. The string is the file name.

sections
To convert only a part of a manual, for example a module like this, some informations are needed about sections above this section.

Module dependencies:

  • Doc_core




UP Package: mldoc