robot.libdocpkg.htmlutils.DocFormatter Class Reference

Public Member Functions
def	__init__ (self, keywords, type_info, introduction, doc_format='ROBOT')
def	html (self, doc, intro=False)

Private Member Functions
def	_encode_uri_component (self, value)
def	_escape_and_encode_targets (self, targets)
def	_get_targets (self, keywords, introduction, robot_format)
def	_get_type_info_targets (self, type_info)
def	_link_keywords (self, match)
def	_yield_header_targets (self, introduction)

Private Attributes
	_doc_to_html
	_targets
	_type_info_targets

Static Private Attributes
	_header_regexp
	_name_regexp

Detailed Description

Definition at line 27 of file htmlutils.py.

Constructor & Destructor Documentation

__init__()

def robot.libdocpkg.htmlutils.DocFormatter.__init__	(		self,
			keywords,
			type_info,
			introduction,
			doc_format = 'ROBOT'
	)

Definition at line 37 of file htmlutils.py.

Member Function Documentation

_encode_uri_component()

def robot.libdocpkg.htmlutils.DocFormatter._encode_uri_component (   self,   value  )

private

Definition at line 73 of file htmlutils.py.

_escape_and_encode_targets()

def robot.libdocpkg.htmlutils.DocFormatter._escape_and_encode_targets (   self,   targets  )

private

Definition at line 69 of file htmlutils.py.

_get_targets()

def robot.libdocpkg.htmlutils.DocFormatter._get_targets (   self,   keywords,   introduction,   robot_format  )

private

Definition at line 43 of file htmlutils.py.

_get_type_info_targets()

def robot.libdocpkg.htmlutils.DocFormatter._get_type_info_targets (   self,   type_info  )

private

Definition at line 58 of file htmlutils.py.

_link_keywords()

def robot.libdocpkg.htmlutils.DocFormatter._link_keywords (   self,   match  )

private

Definition at line 83 of file htmlutils.py.

_yield_header_targets()

def robot.libdocpkg.htmlutils.DocFormatter._yield_header_targets (   self,   introduction  )

private

Definition at line 62 of file htmlutils.py.

html()

def robot.libdocpkg.htmlutils.DocFormatter.html	(		self,
			doc,
			intro = False
	)

Definition at line 77 of file htmlutils.py.

Member Data Documentation

_doc_to_html

robot.libdocpkg.htmlutils.DocFormatter._doc_to_html

private

Definition at line 38 of file htmlutils.py.

_header_regexp

robot.libdocpkg.htmlutils.DocFormatter._header_regexp

staticprivate

Definition at line 31 of file htmlutils.py.

_name_regexp

robot.libdocpkg.htmlutils.DocFormatter._name_regexp

staticprivate

Definition at line 35 of file htmlutils.py.

_targets

robot.libdocpkg.htmlutils.DocFormatter._targets

private

Definition at line 39 of file htmlutils.py.

_type_info_targets

robot.libdocpkg.htmlutils.DocFormatter._type_info_targets

private

Definition at line 41 of file htmlutils.py.

---

The documentation for this class was generated from the following file:

• src/robot/libdocpkg/htmlutils.py