robotide.lib.robot.libdoc Namespace Reference

Classes
class	LibDoc

Functions
def	libdoc (library_or_resource, outfile, name='', version='', format=None, docformat=None)
	Executes Libdoc. More...
def	libdoc_cli (arguments)
	Executes Libdoc similarly as from the command line. More...

Variables
string	USAGE

Function Documentation

libdoc()

def robotide.lib.robot.libdoc.libdoc	(		library_or_resource,
			outfile,
			name = '',
			version = '',
			format = None,
			docformat = None
	)

Executes Libdoc.

:param library_or_resource: Name or path of the test library or resource
    file to be documented.
:param outfile: Path path to the file where to write outputs.
:param name: Custom name to give to the documented library or resource.
:param version: Version to give to the documented library or resource.
:param format: Specifies whether to generate HTML or XML output. If this
    options is not used, the format is got from the extension of
    the output file. Possible values are ``'HTML'`` and ``'XML'``.
:param docformat: Documentation source format. Possible values are
    ``'ROBOT'``, ``'reST'``, ``'HTML'`` and ``'TEXT'``. The default value
    can be specified in test library source code and the initial default
    is ``'ROBOT'``. New in Robot Framework 3.0.3.

Arguments have same semantics as Libdoc command line options with
same names. Run ``python -m robot.libdoc --help`` or consult the Libdoc
section in the Robot Framework User Guide for more details.

Example::

    from robotide.lib.robot.libdoc import libdoc

    libdoc('MyLibrary.py', 'MyLibraryDoc.html', version='1.0')

Definition at line 222 of file libdoc.py.

libdoc_cli()

def robotide.lib.robot.libdoc.libdoc_cli

(

arguments

)

Executes Libdoc similarly as from the command line.

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

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

Example::

    from robotide.lib.robot.libdoc import libdoc_cli

    libdoc_cli(['--version', '1.0', 'MyLibrary.py', 'MyLibraryDoc.html'])

Definition at line 193 of file libdoc.py.

Variable Documentation

USAGE

string robotide.lib.robot.libdoc.USAGE

Definition at line 47 of file libdoc.py.