Submodules

robot.libdocpkg.builder module

robot.libdocpkg.builder.LibraryDocumentation(library_or_resource,name=None,version=None,doc_format=None)[source]

Generate keyword documentation for the given library, resource or suite file.

Parameters:

• library_or_resource – Name or path of the library, or path of a resource or a suite file.

• name – Set name with the given value.

• version – Set version to the given value.

• doc_format – Set documentation format to the given value.

Returns:

LibraryDoc instance.

This factory method is the recommended API to generate keyword documentationprogrammatically. It should be imported via therobot.libdoc module.

Example:

fromrobot.libdocimportLibraryDocumentationlib=LibraryDocumentation('OperatingSystem')print(lib.name,lib.version)forkwinlib.keywords:print(kw.name)

classrobot.libdocpkg.builder.DocumentationBuilder[source]

Bases:object

Keyword documentation builder.

This is not part of Libdoc’s public API. UseLibraryDocumentation()instead.

build(source)[source]

robot.libdocpkg.consoleviewer module

classrobot.libdocpkg.consoleviewer.ConsoleViewer(libdoc)[source]

Bases:object

classmethodhandles(command)[source]

classmethodvalidate_command(command,args)[source]

view(command,*args)[source]

list(*patterns)[source]

show(*names)[source]

version()[source]

classrobot.libdocpkg.consoleviewer.KeywordMatcher(libdoc)[source]

Bases:object

search(patterns)[source]

robot.libdocpkg.datatypes module

classrobot.libdocpkg.datatypes.TypeDoc(type,name,doc,accepts=(),usages=None,members=None,items=None)[source]

Bases:Sortable

ENUM='Enum'

TYPED_DICT='TypedDict'

CUSTOM='Custom'

STANDARD='Standard'

classmethodfor_type(type_info,converters)[source]

classmethodfor_enum(enum)[source]

classmethodfor_typed_dict(typed_dict)[source]

to_dictionary()[source]

classrobot.libdocpkg.datatypes.TypedDictItem(key,type,required=None)[source]

Bases:object

to_dictionary()[source]

classrobot.libdocpkg.datatypes.EnumMember(name,value)[source]

Bases:object

to_dictionary()[source]

robot.libdocpkg.htmlutils module

classrobot.libdocpkg.htmlutils.DocFormatter(keywords,type_info,introduction,doc_format='ROBOT')[source]

Bases:object

html(doc,intro=False)[source]

classrobot.libdocpkg.htmlutils.DocToHtml(doc_format)[source]

Bases:object

classrobot.libdocpkg.htmlutils.HtmlToText[source]

Bases:object

html_tags={'b':'*','code':'``','div.*?':'','em':'_','i':'_','strong':'*'}

html_chars={'&amp;':'&','&apos;':"'",'&gt;':'>','&lt;':'<','&quot;':'"','<br*/?>':'\n'}

get_short_doc_from_html(doc)[source]

html_to_plain_text(doc)[source]

robot.libdocpkg.htmlwriter module

classrobot.libdocpkg.htmlwriter.LibdocHtmlWriter(theme=None,lang=None)[source]

Bases:object

write(libdoc,output)[source]

classrobot.libdocpkg.htmlwriter.LibdocModelWriter(output,libdoc,theme=None,lang=None)[source]

Bases:ModelWriter

write(line)[source]

robot.libdocpkg.jsonbuilder module

classrobot.libdocpkg.jsonbuilder.JsonDocBuilder[source]

Bases:object

build(path)[source]

build_from_dict(spec)[source]

robot.libdocpkg.jsonwriter module

classrobot.libdocpkg.jsonwriter.LibdocJsonWriter[source]

Bases:object

write(libdoc,outfile)[source]

robot.libdocpkg.languages module

robot.libdocpkg.languages.format_languages()[source]

robot.libdocpkg.model module

classrobot.libdocpkg.model.LibraryDoc(name='',doc='',version='',type='LIBRARY',scope='TEST',doc_format='ROBOT',source=None,lineno=-1)[source]

Bases:object

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

propertydoc

doc_format

inits

Initializer docs asKeywordDoc instances.

keywords

Keyword docs asKeywordDoc instances.

type_docs

propertyall_tags

save(output=None,format='HTML',theme=None,lang=None)[source]

convert_docs_to_html()[source]

to_dictionary(include_private=False,theme=None,lang=None)[source]

to_json(indent=None,include_private=True,theme=None,lang=None)[source]

classrobot.libdocpkg.model.KeywordDoc(name='',args=None,doc='',short_doc='',tags=(),private=False,deprecated=False,source=None,lineno=-1,parent=None)[source]

Bases:Sortable

Documentation for a single keyword or an initializer.

propertyshort_doc

to_dictionary()[source]

robot.libdocpkg.output module

classrobot.libdocpkg.output.LibdocOutput(output_path,format)[source]

Bases:object

robot.libdocpkg.output.get_generation_time()[source]

Return a timestamp that honorsSOURCE_DATE_EPOCH.

This timestamp is to be used for embedding in output files, sothat builds can be made reproducible.

robot.libdocpkg.robotbuilder module

classrobot.libdocpkg.robotbuilder.LibraryDocBuilder[source]

Bases:object

build(library)[source]

classrobot.libdocpkg.robotbuilder.ResourceDocBuilder[source]

Bases:object

type='RESOURCE'

build(path)[source]

classrobot.libdocpkg.robotbuilder.SuiteDocBuilder[source]

Bases:ResourceDocBuilder

type='SUITE'

classrobot.libdocpkg.robotbuilder.KeywordDocBuilder(resource=False)[source]

Bases:object

build_keywords(owner)[source]

build_keyword(kw)[source]

robot.libdocpkg.standardtypes module

robot.libdocpkg.writer module

robot.libdocpkg.writer.LibdocWriter(format=None,theme=None,lang=None)[source]

robot.libdocpkg.xmlbuilder module

classrobot.libdocpkg.xmlbuilder.XmlDocBuilder[source]

Bases:object

build(path)[source]

robot.libdocpkg.xmlwriter module

classrobot.libdocpkg.xmlwriter.LibdocXmlWriter[source]

Bases:object

write(libdoc,outfile)[source]