robot.libdocpkg.builder.DocumentationBuilder Class Reference

Keyword documentation builder. More...

Public Member Functions
def	__init__ (self, library_or_resource=None)
	library_or_resource is accepted for backwards compatibility reasons. More...
def	build (self, source)

Private Member Functions
def	_build (self, builder, source)
def	_get_builder (self, source)
def	_get_extension (self, source)

Detailed Description

Keyword documentation builder.

This is not part of Libdoc's public API. Use :func:`LibraryDocumentation`
instead.

Definition at line 71 of file builder.py.

Constructor & Destructor Documentation

__init__()

def robot.libdocpkg.builder.DocumentationBuilder.__init__	(		self,
			library_or_resource = None
	)

library_or_resource is accepted for backwards compatibility reasons.

    It is not used for anything internally and passing it to the builder is
    considered deprecated starting from RF 6.0.1.

Definition at line 78 of file builder.py.

Member Function Documentation

_build()

def robot.libdocpkg.builder.DocumentationBuilder._build (   self,   builder,   source  )

private

Definition at line 102 of file builder.py.

_get_builder()

def robot.libdocpkg.builder.DocumentationBuilder._get_builder (   self,   source  )

private

Definition at line 85 of file builder.py.

_get_extension()

def robot.libdocpkg.builder.DocumentationBuilder._get_extension (   self,   source  )

private

Definition at line 98 of file builder.py.

build()

def robot.libdocpkg.builder.DocumentationBuilder.build	(		self,
			source
	)

Definition at line 81 of file builder.py.

---

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

• src/robot/libdocpkg/builder.py