robotframework:libdoc

Full name:

org.robotframework:robotframework-maven-plugin:1.4.7:libdoc

Description:

Create documentation of test libraries or resource files using the Robot Framework libdoc tool. Uses the libdoc bundled in Robot Framework jar distribution. For more help see libdoc documentation.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Required Parameters

Name Type Since Description
libdoc LibDocConfiguration - Library documentation configuration. Required settings:
  • outputFile The name for the output file. Documentation output format is deduced from the file extension.
  • libraryOrResourceFile Name or path of the documented library or resource file. Name must be in the same format as when used in Robot Framework test data, for example BuiltIn or com.acme.FooLibrary. When name is used, the library is imported the same as when running the tests. Use extraPathDirectories to set PYTHONPATH/CLASSPATH accordingly. Paths are considered relative to the location of pom.xml and must point to a valid Python/Java source file or a resource file. For example src/main/python/test/ExampleLib.py Note that you should preferably import java classes by classname, not path. Dynamic libraries will not be compiled correctly with path.
Optional settings:
  • outputDirectory Specifies the directory where documentation files are written. Considered to be relative to the ${basedir} of the project. Default ${project.build.directory}/robotframework/libdoc
  • name Sets the name of the documented library or resource.
  • version Sets the version of the documented library or resource.
  • extraPathDirectories A directory to be added to the PYTHONPATH/CLASSPATH when creating documentation. e.g. src/main/java/com/test/
Example:
<libdoc>
     <outputFile>MyLib.html</outputFile>
     <libraryOrResourceFile>com.mylib.MyLib</libraryOrResourceFile>
</libdoc>

Parameter Details

libdoc:

Library documentation configuration. Required settings:
  • outputFile The name for the output file. Documentation output format is deduced from the file extension.
  • libraryOrResourceFile Name or path of the documented library or resource file. Name must be in the same format as when used in Robot Framework test data, for example BuiltIn or com.acme.FooLibrary. When name is used, the library is imported the same as when running the tests. Use extraPathDirectories to set PYTHONPATH/CLASSPATH accordingly. Paths are considered relative to the location of pom.xml and must point to a valid Python/Java source file or a resource file. For example src/main/python/test/ExampleLib.py Note that you should preferably import java classes by classname, not path. Dynamic libraries will not be compiled correctly with path.
Optional settings:
  • outputDirectory Specifies the directory where documentation files are written. Considered to be relative to the ${basedir} of the project. Default ${project.build.directory}/robotframework/libdoc
  • name Sets the name of the documented library or resource.
  • version Sets the version of the documented library or resource.
  • extraPathDirectories A directory to be added to the PYTHONPATH/CLASSPATH when creating documentation. e.g. src/main/java/com/test/
Example:
<libdoc>
     <outputFile>MyLib.html</outputFile>
     <libraryOrResourceFile>com.mylib.MyLib</libraryOrResourceFile>
</libdoc>
  • Type: org.robotframework.mavenplugin.LibDocConfiguration
  • Required: Yes