Function File: html_help_text (name, outname, options) ¶

Writes a function help text to disk formatted as HTML.

The help text of the function name is written to the file outname formatted as HTML. The design of the generated HTML page is controlled through the options variable. This is a structure with the following optional fields.

‘header’

This field contains the HTML header of the generated file. Through this things such as CSS style sheets can be set.

‘footer’

This field contains the HTML footer of the generated file. This should match the ‘header’ field to ensure all opened tags get closed.

‘title’

This field sets the title of the HTML page. This is enforced even if the ‘header’ field contains a title.

options structures for various projects can be with the get_html_options function. As a convenience, if options is a string, a structure will be generated by calling get_html_options.

See also: get_html_options, generate_package_html.

Package: generate_html