Metadata-Version: 2.1
Name: mlx.robot2rst
Version: 2.0.1
Summary: Python script for converting a Robot Framework file to a reStructuredText (.rst) file
Home-page: https://github.com/melexis/robot2rst
Author: Jasper Craeghs
Author-email: jce@melexis.com
License: Apache License Version 2.0
Description: .. image:: https://api.travis-ci.com/melexis/robot2rst.svg?branch=master
            :target: https://travis-ci.com/melexis/robot2rst
            :alt: Build status
        
        .. image:: https://img.shields.io/badge/Documentation-published-brightgreen.svg
            :target: https://melexis.github.io/robot2rst/
            :alt: Documentation
        
        .. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
            :target: https://github.com/melexis/robot2rst/issues
            :alt: Contributions welcome
        
        =======================
        Documentation robot2rst
        =======================
        
        This script can convert your .robot files from Robot Framework to reStructuredText (.rst) files with traceable items.
        
        .. contents:: `Contents`
            :depth: 2
            :local:
        
        ----
        Goal
        ----
        
        This script allows you to connect your requirements to test cases via the `mlx.traceability`_ Sphinx extension.
        Test cases get converted to traceable items. The documentation of each test gets used to generate the body of the item.
        Test case names get converted to item IDs with a configurable prefix. Tags can be used to link to other traceable items.
        
        -----
        Usage
        -----
        
        .. code-block:: console
        
            robot2rst -i example.robot -o test_plan.rst --prefix ITEST_MY_LIB- --tags SWRQT- SYSRQT- --relationships validates ext_toolname
        
            $ robot2rst --help
        
            usage: robot2rst [-h] -i ROBOT_FILE -o RST_FILE [-p PREFIX]
                             [-r [RELATIONSHIPS [RELATIONSHIPS ...]]]
                             [-t [TAGS [TAGS ...]]] [--trim-suffix]
        
            Convert robot test cases to reStructuredText with traceable items.
        
            optional arguments:
              -h, --help            show this help message and exit
              -i ROBOT_FILE, --robot ROBOT_FILE
                                    Input robot file
              -o RST_FILE, --rst RST_FILE
                                    Output RST file
              -p PREFIX, --prefix PREFIX
                                    Overrides the default 'ITEST-' prefix.
              -r [RELATIONSHIPS [RELATIONSHIPS ...]], --relationships [RELATIONSHIPS [RELATIONSHIPS ...]]
                                    Name(s) of the relationship(s) used to link to items
                                    in Tags section. The default value is 'validates'.
              -t [TAGS [TAGS ...]], --tags [TAGS [TAGS ...]]
                                    Regex(es) for matching tags to add a relationship link
                                    for. All tags get matched by default.
              --trim-suffix         If the suffix of any prefix or --tags argument ends
                                    with '_-' it gets trimmed to '-'.
        
        -------------
        Configuration
        -------------
        
        To include the script's output in your documentation you want to add the aforementioned extension to your
        ``extensions`` list in your *conf.py* like so:
        
        .. code-block:: python
        
            extensions = [
                'mlx.traceability',
            ]
        
        Please read the `documentation of mlx.traceability`_ for additional configuration steps.
        
        .. _`mlx.traceability`: https://pypi.org/project/mlx.traceability/
        .. _`documentation of mlx.traceability`: https://melexis.github.io/sphinx-traceability-extension/readme.html
        
Keywords: robot,robotframework,sphinx,traceability
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
