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.LibraryDocumentation(library_or_resource, name=None, version=None, doc_format=None)[source]
-
robot.libdocpkg.builder.DocumentationBuilder(library_or_resource)[source]
Create a documentation builder for the specified library or resource.
The argument can be a path to a library, a resource file or to a spec file
generated by Libdoc earlier. If the argument does not point to an existing file,
it is expected to be the name of the library to be imported. If a resource file
is to be imported from PYTHONPATH, then ResourceDocBuilder
must be used explicitly instead.
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.TypeDoc(type, name, doc, accepts=(), usages=None, members=None, items=None)[source]
Bases: robot.utils.sortable.Sortable
-
ENUM = 'Enum'
-
TYPED_DICT = 'TypedDict'
-
CUSTOM = 'Custom'
-
STANDARD = 'Standard'
-
classmethod
for_type(type, converters)[source]
-
classmethod
for_enum(enum)[source]
-
classmethod
for_typed_dict(typed_dict)[source]
-
to_dictionary(legacy=False)[source]
-
class
robot.libdocpkg.datatypes.TypedDictItem(key, type, required=None)[source]
Bases: object
-
to_dictionary()[source]
-
class
robot.libdocpkg.datatypes.EnumMember(name, value)[source]
Bases: object
-
to_dictionary()[source]
robot.libdocpkg.htmlutils module
-
class
robot.libdocpkg.htmlutils.DocFormatter(keywords, type_info, 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 = {'&': '&', ''': "'", '>': '>', '<': '<', '"': '"', '<br */?>': '\n'}
-
get_shortdoc_from_html(doc)[source]
-
html_to_plain_text(doc)[source]
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
-
type_docs
-
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=None, doc='', shortdoc='', tags=(), source=None, lineno=-1, parent=None)[source]
Bases: robot.utils.sortable.Sortable
-
shortdoc
-
deprecated
-
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.standardtypes module
robot.libdocpkg.writer module
-
robot.libdocpkg.writer.LibdocWriter(format=None)[source]
robot.libdocpkg.xmlbuilder module
-
class
robot.libdocpkg.xmlbuilder.XmlDocBuilder[source]
Bases: object
-
build(path)[source]
robot.libdocpkg.xmlwriter module
-
class
robot.libdocpkg.xmlwriter.LibdocXmlWriter[source]
Bases: object
-
write(libdoc, outfile)[source]