# eric6.UI.CodeDocumentationViewerTemplate

Module implementing functions to prepare an HTML documentation view.

### Global Attributes

None

### Classes

None

### Functions

prepareDocumentationViewerHtmlDocWarningDocument | Public function to prepare a HTML warning document.
prepareDocumentationViewerHtmlDocument | Public function to prepare the HTML document.
prepareDocumentationViewerHtmlWarningDocument | Public function to prepare a HTML warning document.

## prepareDocumentationViewerHtmlDocWarningDocument

prepareDocumentationViewerHtmlDocWarningDocument(text)

Public function to prepare a HTML warning document.

text (str)
  warning text to be shown

Returns:
  prepared HTML document

Return Type:
  str

Up

## prepareDocumentationViewerHtmlDocument

prepareDocumentationViewerHtmlDocument(documentationInfo)

Public function to prepare the HTML document.

documentationInfo (dict)
  dictionary containing the various documentation parts

Returns:
  prepared HTML document

Return Type:
  str

Up

## prepareDocumentationViewerHtmlWarningDocument

prepareDocumentationViewerHtmlWarningDocument(text)

Public function to prepare a HTML warning document.

text (str)
  warning text to be shown

Returns:
  prepared HTML document

Return Type:
  str

Up