robot.libdocpkg package

Implements the Libdoc tool.

The command line entry point and programmatic interface for Libdoc are provided by the separate robot.libdoc module.

This package is considered stable but it is not part of the public API.

Submodules

robot.libdocpkg.builder module

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

robot.libdocpkg.consoleviewer module

class robot.libdocpkg.consoleviewer.ConsoleViewer(libdoc)[source]

Bases: object

classmethod handles(command)[source]
classmethod validate_command(command, args)[source]
view(command, *args)[source]
list(*patterns)[source]
show(*names)[source]
version()[source]
class robot.libdocpkg.consoleviewer.KeywordMatcher(libdoc)[source]

Bases: object

search(patterns)[source]

robot.libdocpkg.datatypes module

class robot.libdocpkg.datatypes.EnumType[source]

Bases: object

class robot.libdocpkg.datatypes.ExtTypedDictType[source]

Bases: object

class robot.libdocpkg.datatypes.DataTypeCatalog[source]

Bases: object

enums
typed_dicts
update(types)[source]
to_dictionary()[source]
class robot.libdocpkg.datatypes.TypedDictDoc(name='', doc='', items=None, type='TypedDict')[source]

Bases: robot.utils.sortable.Sortable

classmethod from_TypedDict(typed_dict)[source]
to_dictionary()[source]
class robot.libdocpkg.datatypes.EnumDoc(name='', doc='', members=None, type='Enum')[source]

Bases: robot.utils.sortable.Sortable

classmethod from_Enum(enum_type)[source]
to_dictionary()[source]

robot.libdocpkg.htmlutils module

class robot.libdocpkg.htmlutils.DocFormatter(keywords, data_types, introduction, doc_format='ROBOT')[source]

Bases: object

html(doc, intro=False)[source]
class robot.libdocpkg.htmlutils.DocToHtml(doc_format)[source]

Bases: object

class robot.libdocpkg.htmlutils.HtmlToText[source]

Bases: object

html_tags = {'b': '*', 'code': '``', 'div.*?': '', 'em': '_', 'i': '_', 'strong': '*'}
html_chars = {'&amp;': '&', '&apos;': "'", '&gt;': '>', '&lt;': '<', '&quot;': '"', '<br */?>': '\n'}
get_shortdoc_from_html(doc)[source]
html_to_plain_text(doc)[source]

robot.libdocpkg.htmlwriter module

class robot.libdocpkg.htmlwriter.LibdocHtmlWriter[source]

Bases: object

write(libdoc, output)[source]
class robot.libdocpkg.htmlwriter.LibdocModelWriter(output, libdoc)[source]

Bases: robot.htmldata.htmlfilewriter.ModelWriter

write(line)[source]
handles(line)

robot.libdocpkg.java9builder module

robot.libdocpkg.javabuilder module

class robot.libdocpkg.javabuilder.JavaDocBuilder[source]

Bases: object

build(path)[source]
robot.libdocpkg.javabuilder.ClassDoc(path)[source]

Process the given Java source file and return ClassDoc instance.

Processing is done using com.sun.tools.javadoc APIs. Returned object implements com.sun.javadoc.ClassDoc interface: http://docs.oracle.com/javase/7/docs/jdk/api/javadoc/doclet/

robot.libdocpkg.jsonbuilder module

class robot.libdocpkg.jsonbuilder.JsonDocBuilder[source]

Bases: object

build(path)[source]
build_from_dict(spec)[source]

robot.libdocpkg.jsonwriter module

class robot.libdocpkg.jsonwriter.LibdocJsonWriter[source]

Bases: object

write(libdoc, outfile)[source]

robot.libdocpkg.model module

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

Bases: object

doc
doc_format
inits
keywords
all_tags
save(output=None, format='HTML')[source]
convert_docs_to_html()[source]
to_dictionary()[source]
to_json(indent=None)[source]
class robot.libdocpkg.model.KeywordDoc(name='', args=(), doc='', shortdoc='', tags=(), source=None, lineno=-1, parent=None)[source]

Bases: robot.utils.sortable.Sortable

shortdoc
deprecated
generate_shortdoc()[source]
to_dictionary()[source]

robot.libdocpkg.output module

class robot.libdocpkg.output.LibdocOutput(output_path, format)[source]

Bases: object

robot.libdocpkg.robotbuilder module

class robot.libdocpkg.robotbuilder.LibraryDocBuilder[source]

Bases: object

build(library)[source]
class robot.libdocpkg.robotbuilder.ResourceDocBuilder[source]

Bases: object

build(path)[source]
class robot.libdocpkg.robotbuilder.KeywordDocBuilder(resource=False)[source]

Bases: object

build_keywords(lib)[source]
build_keyword(kw)[source]

robot.libdocpkg.specbuilder module

class robot.libdocpkg.specbuilder.SpecDocBuilder[source]

Bases: object

build(path)[source]

robot.libdocpkg.writer module

robot.libdocpkg.writer.LibdocWriter(format=None)[source]

robot.libdocpkg.xmlwriter module

class robot.libdocpkg.xmlwriter.LibdocXmlWriter[source]

Bases: object

write(libdoc, outfile)[source]