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.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]
-
write_data
()[source]
-
handles
(line)
-
class
robot.libdocpkg.htmlwriter.
JsonConverter
(doc_formatter)[source]
Bases: object
-
convert
(libdoc)[source]
-
class
robot.libdocpkg.htmlwriter.
DocFormatter
(keywords, introduction, doc_format='ROBOT')[source]
Bases: object
-
html
(doc, intro=False)[source]
-
class
robot.libdocpkg.htmlwriter.
DocToHtml
(doc_format)[source]
Bases: object
robot.libdocpkg.java9builder module
robot.libdocpkg.model module
-
class
robot.libdocpkg.model.
LibraryDoc
(name='', doc='', version='', type='LIBRARY', scope='TEST', named_args=True, doc_format='ROBOT', source=None, lineno=-1)[source]
Bases: object
-
doc
-
doc_format
-
keywords
-
all_tags
-
save
(output=None, format='HTML')[source]
-
class
robot.libdocpkg.model.
KeywordDoc
(name='', args=(), doc='', tags=(), source=None, lineno=-1)[source]
Bases: robot.utils.sortable.Sortable
-
shortdoc
-
deprecated
robot.libdocpkg.output module
-
class
robot.libdocpkg.output.
LibdocOutput
(output_path, format)[source]
Bases: object
robot.libdocpkg.robotbuilder module
-
class
robot.libdocpkg.robotbuilder.
Enum
[source]
Bases: object
-
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
(force_html_doc=False)[source]
Bases: object
-
write
(libdoc, outfile)[source]
-
class
robot.libdocpkg.xmlwriter.
DocFormatter
(doc_format, force_html=False)[source]
Bases: object