Classes
class	JsonConverter

class	TestDoc

class	TestdocModelWriter

Functions
def	testdoc (arguments, *options)
	Executes `Testdoc` programmatically. More...

def	testdoc_cli (arguments)
	Executes `Testdoc` similarly as from the command line. More...

def	TestSuiteFactory (datasources, **options)

Variables
string	USAGE

Function Documentation

◆ testdoc()

def robot.testdoc.testdoc	(	*	arguments,
		**	options
	)

Executes Testdoc programmatically.

Arguments and options have same semantics, and options have same names,
as arguments and options to Testdoc.

Example::

    from robot.testdoc import testdoc

    testdoc('mytests', 'plan.html', title='Test Plan')

Definition at line 312 of file testdoc.py.

◆ testdoc_cli()

def robot.testdoc.testdoc_cli ( arguments )

Executes Testdoc similarly as from the command line.

:param arguments: command line arguments as a list of strings.

For programmatic usage the :func:`testdoc` function is typically better. It
has a better API for that and does not call :func:`sys.exit` like
this function.

Example::

    from robot.testdoc import testdoc_cli

    testdoc_cli(['--title', 'Test Plan', 'mytests', 'plan.html'])

Definition at line 297 of file testdoc.py.

◆ TestSuiteFactory()

def robot.testdoc.TestSuiteFactory	(		datasources,
		**	options
	)

Definition at line 131 of file testdoc.py.

Variable Documentation

◆ USAGE

string robot.testdoc.USAGE

Definition at line 49 of file testdoc.py.

Classes