Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use libdoc_cli method in Robotframework

Best Python code snippet using robotframework

libdoc.py

Source:libdoc.py

...138        if format not in valid:139            raise DataError("%s must be %s, got '%s'."140                            % (type, seq2str(valid, lastsep=' or '), format))141        return format142def libdoc_cli(arguments):143    """Executes Libdoc similarly as from the command line.144    :param arguments: Command line arguments as a list of strings.145    For programmatic usage the :func:`libdoc` function is typically better. It146    has a better API for that usage and does not call :func:`sys.exit` like147    this function.148    Example::149        from robot.libdoc import libdoc_cli150        libdoc_cli(['--version', '1.0', 'MyLibrary.py', 'MyLibraryDoc.html'])151    """152    LibDoc().execute_cli(arguments)153def libdoc(library_or_resource, outfile, name='', version='', format=None):154    """Executes Libdoc.155    :param library_or_resource: Name or path of the test library or resource156        file to be documented.157    :param outfile: Path path to the file where to write outputs.158    :param name: Custom name to give to the documented library or resource.159    :param version: Version to give to the documented library or resource.160    :param format: Documentation source format. Possible values are ``ROBOT``,161        ``reST``, ``HTML`` and ``TEXT``. Default value is ``ROBOT`` but162        libraries can override it themselves.163    Arguments have same semantics as Libdoc command line options with164    same names. Run ``python -m robot.libdoc --help`` or consult the Libdoc165    section in the Robot Framework User Guide for more details.166    Example::167        from robot.libdoc import libdoc168        libdoc('MyLibrary.py', 'MyLibraryDoc.html', version='1.0')169    """170    LibDoc().execute(library_or_resource, outfile, name=name, version=version,171                     format=format)172if __name__ == '__main__':...

__main__.py

Source:__main__.py

...36        parser.print_help()37    args = parser.parse_args()38    # handle known options39    if args.all:40        print(libdoc.libdoc_cli(["QWeb", "list"]))41    elif args.list:42        print(libdoc.libdoc_cli(["QWeb", "list", args.list]))43    elif args.show:44        print(libdoc.libdoc_cli(["QWeb", "show", args.show]))45if __name__ == "__main__":46    __version__ = get_versions()['version']47    del get_versions...

run.py

Source:run.py

...32        targetpath = _create_docs_path(docroot, sourcefile)33        print '{} =>'.format(sourcefile)34        used_libdoc_args.extend([sourcefile, targetpath])35        try:36            libdoc_cli(used_libdoc_args)37        except SystemExit as e: # libdoc_cli calls sys.exit()38            if e.code != 0:39                raise40        print '---'41def main(cli_args):42    extend_pythonpath(LIBROOT)43    if len(cli_args) > 0 and cli_args[0] == 'docs':44        return generate_docs(cli_args[1:], LIBROOT, RESOURCEROOT, DOCROOT)45    cli_args.extend(DEFAULT_ARGS.split())46    return run_cli(cli_args)47if __name__ == '__main__':...

nbreader.py

Source:nbreader.py

...13    return run_cli(sys.argv[1:])14def libdoc():15    inject_robot_ipynb_support()16    inject_libdoc_ipynb_support()17    return libdoc_cli(sys.argv[1:])18if __name__ == "__main__":...

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.