Lib.robot.libdocpkg.init.py Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sikulixapi Show documentation

... for visual testing and automation

There is a newer version: 2.0.5

#  Copyright 2008-2015 Nokia Solutions and Networks
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.

"""Implements the `Libdoc` tool.

The command line entry point and programmatic interface for Libdoc
are provided by the separate :mod:`robot.libdoc` module.

This package is considered stable but it is not part of the public API.
"""

from robot.errors import DataError
from robot.utils import get_error_message

from .builder import DocumentationBuilder
from .consoleviewer import ConsoleViewer


def LibraryDocumentation(library_or_resource, name=None, version=None,
                         doc_format=None):
    builder = DocumentationBuilder(library_or_resource)
    try:
        libdoc = builder.build(library_or_resource)
    except DataError:
        raise
    except:
        raise DataError("Building library '%s' failed: %s"
                        % (library_or_resource, get_error_message()))
    if name:
        libdoc.name = name
    if version:
        libdoc.version = version
    if doc_format:
        libdoc.doc_format = doc_format
    return libdoc

Lib.robot.libdocpkg.__init__.py Maven / Gradle / Ivy

Lib.robot.libdocpkg.init.py Maven / Gradle / Ivy