robot.libdocpkg.model.LibraryDoc Class Reference

Documentation for a library, a resource file or a suite file. More...

Public Member Functions
def	__init__ (self, name='', doc='', version='', type='LIBRARY', scope='TEST', doc_format='ROBOT', source=None, lineno=-1)
def	convert_docs_to_html (self)
def	doc_format (self, format)
def	inits (self, inits)
	Initializer docs as :class:~KeywordDoc instances. More...
def	keywords (self, kws)
	Keyword docs as :class:~KeywordDoc instances. More...
def	save (self, output=None, format='HTML', theme=None)
def	to_dictionary (self, include_private=False, theme=None)
def	to_json (self, indent=None, include_private=True, theme=None)
def	type_docs (self, type_docs)

Public Attributes
	doc_format
	inits
	keywords
	lineno
	name
	scope
	source
	type
	type_docs
	version

Properties
	all_tags = property
	doc = property

Private Member Functions
def	_add_toc (self, doc)
def	_create_toc (self, doc)
def	_get_data_types (self, types)
def	_process_keywords (self, kws)
def	all_tags (self)
def	doc (self)

Private Attributes
	_doc

Detailed Description

Documentation for a library, a resource file or a suite file.

Definition at line 30 of file model.py.

Constructor & Destructor Documentation

__init__()

def robot.libdocpkg.model.LibraryDoc.__init__	(		self,
			name = '',
			doc = '',
			version = '',
			type = 'LIBRARY',
			scope = 'TEST',
			doc_format = 'ROBOT',
			source = None,
			lineno = -1
	)

Definition at line 32 of file model.py.

Member Function Documentation

_add_toc()

def robot.libdocpkg.model.LibraryDoc._add_toc (   self,   doc  )

private

Definition at line 54 of file model.py.

_create_toc()

def robot.libdocpkg.model.LibraryDoc._create_toc (   self,   doc  )

private

Definition at line 59 of file model.py.

_get_data_types()

def robot.libdocpkg.model.LibraryDoc._get_data_types (   self,   types  )

private

Definition at line 142 of file model.py.

_process_keywords()

def robot.libdocpkg.model.LibraryDoc._process_keywords (   self,   kws  )

private

Definition at line 85 of file model.py.

all_tags()

def robot.libdocpkg.model.LibraryDoc.all_tags (   self )

private

Definition at line 93 of file model.py.

convert_docs_to_html()

def robot.libdocpkg.model.LibraryDoc.convert_docs_to_html

(

self

)

Definition at line 100 of file model.py.

doc()

def robot.libdocpkg.model.LibraryDoc.doc (   self )

private

Definition at line 49 of file model.py.

doc_format()

def robot.libdocpkg.model.LibraryDoc.doc_format	(		self,
			format
	)

Definition at line 68 of file model.py.

inits()

def robot.libdocpkg.model.LibraryDoc.inits	(		self,
			inits
	)

Initializer docs as :class:~KeywordDoc instances.

Definition at line 73 of file model.py.

keywords()

def robot.libdocpkg.model.LibraryDoc.keywords	(		self,
			kws
	)

Keyword docs as :class:~KeywordDoc instances.

Definition at line 78 of file model.py.

save()

def robot.libdocpkg.model.LibraryDoc.save	(		self,
			output = None,
			format = 'HTML',
			theme = None
	)

Definition at line 96 of file model.py.

to_dictionary()

def robot.libdocpkg.model.LibraryDoc.to_dictionary	(		self,
			include_private = False,
			theme = None
	)

Definition at line 118 of file model.py.

to_json()

def robot.libdocpkg.model.LibraryDoc.to_json	(		self,
			indent = None,
			include_private = True,
			theme = None
	)

Definition at line 150 of file model.py.

type_docs()

def robot.libdocpkg.model.LibraryDoc.type_docs	(		self,
			type_docs
	)

Definition at line 82 of file model.py.

Member Data Documentation

_doc

robot.libdocpkg.model.LibraryDoc._doc

private

Definition at line 35 of file model.py.

doc_format

robot.libdocpkg.model.LibraryDoc.doc_format

Definition at line 39 of file model.py.

inits

robot.libdocpkg.model.LibraryDoc.inits

Definition at line 42 of file model.py.

keywords

robot.libdocpkg.model.LibraryDoc.keywords

Definition at line 43 of file model.py.

lineno

robot.libdocpkg.model.LibraryDoc.lineno

Definition at line 41 of file model.py.

name

robot.libdocpkg.model.LibraryDoc.name

Definition at line 34 of file model.py.

scope

robot.libdocpkg.model.LibraryDoc.scope

Definition at line 38 of file model.py.

source

robot.libdocpkg.model.LibraryDoc.source

Definition at line 40 of file model.py.

type

robot.libdocpkg.model.LibraryDoc.type

Definition at line 37 of file model.py.

type_docs

robot.libdocpkg.model.LibraryDoc.type_docs

Definition at line 44 of file model.py.

version

robot.libdocpkg.model.LibraryDoc.version

Definition at line 36 of file model.py.

Property Documentation

all_tags

robot.libdocpkg.model.LibraryDoc.all_tags = property

static

Definition at line 91 of file model.py.

doc

robot.libdocpkg.model.LibraryDoc.doc = property

static

Definition at line 47 of file model.py.

---

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

• src/robot/libdocpkg/model.py