Submodules

robot.libdocpkg.builder module

robot.libdocpkg.builder.JavaDocBuilder()[source]

robot.libdocpkg.builder.DocumentationBuilder(library_or_resource)

robot.libdocpkg.consoleviewer module

classrobot.libdocpkg.consoleviewer.ConsoleViewer(libdoc)

Bases: object

classmethodhandles(command)[source]

classmethodvalidate_command(command, args)

view(command, *args)

list(*patterns)

show(*names)

version()

classrobot.libdocpkg.consoleviewer.KeywordMatcher(libdoc)

Bases: object

search(patterns)[source]

robot.libdocpkg.htmlwriter module

classrobot.libdocpkg.htmlwriter.LibdocHtmlWriter

Bases: object

write(libdoc, output)[source]

classrobot.libdocpkg.htmlwriter.LibdocModelWriter(output, libdoc)

Bases: robot.htmldata.htmlfilewriter.ModelWriter

write(line)

write_data()

handles(line)

classrobot.libdocpkg.htmlwriter.JsonConverter(doc_formatter)

Bases: object

convert(libdoc)

classrobot.libdocpkg.htmlwriter.DocFormatter(keywords, introduction, doc_format='ROBOT')

Bases: object

html(doc, intro=False)

classrobot.libdocpkg.htmlwriter.DocToHtml(doc_format)

Bases: object

robot.libdocpkg.javabuilder module

classrobot.libdocpkg.javabuilder.JavaDocBuilder

Bases: object

build(path)

robot.libdocpkg.javabuilder.ClassDoc(path)

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.model module

classrobot.libdocpkg.model.LibraryDoc(name='', doc='', version='', type='library', scope='',named_args=True, doc_format='')

Bases: object

doc_format

keywords

all_tags

save(output=None, format='HTML')

classrobot.libdocpkg.model.KeywordDoc(name='', args=(), doc='', tags=())

Bases: robot.utils.sortable.Sortable

shortdoc

robot.libdocpkg.output module

classrobot.libdocpkg.output.LibdocOutput(output_path, format)

Bases: object

robot.libdocpkg.robotbuilder module

classrobot.libdocpkg.robotbuilder.LibraryDocBuilder

Bases: object

build(library)

classrobot.libdocpkg.robotbuilder.ResourceDocBuilder

Bases: object

build(path)

classrobot.libdocpkg.robotbuilder.KeywordDocBuilder(resource=False)

Bases: object

build_keywords(lib)

build_keyword(kw)

robot.libdocpkg.specbuilder module

classrobot.libdocpkg.specbuilder.SpecDocBuilder

Bases: object

build(path)

robot.libdocpkg.writer module

robot.libdocpkg.writer.LibdocWriter(format=None)

robot.libdocpkg.xmlwriter module

classrobot.libdocpkg.xmlwriter.LibdocXmlWriter

Bases: object

write(libdoc, outfile)