robot.libdocpkg package¶
Implements the Libdoc tool.
The public Libdoc API is exposed via the robot.libdoc
module.
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 documentation programmatically. It should be imported via the
robot.libdoc
module.Example:
from robot.libdoc import LibraryDocumentation lib = LibraryDocumentation('OperatingSystem') print(lib.name, lib.version) for kw in lib.keywords: print(kw.name)
-
class
robot.libdocpkg.builder.
DocumentationBuilder
(library_or_resource=None)[source]¶ Bases:
object
Keyword documentation builder.
This is not part of Libdoc’s public API. Use
LibraryDocumentation()
instead.library_or_resource is accepted for backwards compatibility reasons.
It is not used for anything internally and passing it to the builder is considered deprecated starting from RF 6.0.1.
robot.libdocpkg.consoleviewer module¶
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'¶
-
robot.libdocpkg.htmlutils module¶
robot.libdocpkg.htmlwriter module¶
robot.libdocpkg.jsonbuilder module¶
robot.libdocpkg.jsonwriter module¶
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
Documentation for a library, a resource file or a suite file.
-
doc
¶
-
doc_format
¶
-
inits
¶ Initializer docs as
KeywordDoc
instances.
-
keywords
¶ Keyword docs as
KeywordDoc
instances.
-
type_docs
¶
-
robot.libdocpkg.output module¶
robot.libdocpkg.robotbuilder module¶
-
class
robot.libdocpkg.robotbuilder.
SuiteDocBuilder
[source]¶ Bases:
robot.libdocpkg.robotbuilder.ResourceDocBuilder
-
type
= 'SUITE'¶
-
build
(path)¶
-