Skip to main content

A script for converting a RobotFramework file, to an RST file

Project description

Build status Documentation Contributions welcome

Documentation robot2rst

This script can convert your .robot files from Robot Framework to reStructuredText (.rst) files with traceable items.

Contents

Goal

This script allows you to connect your requirements to test cases via the mlx.traceability Sphinx extension. The sphinxcontrib-robotdoc Sphinx extension is responsible for embedding the Robot Framework content with syntax highlighting.

Configuration

To include the script’s output in your documentation you want to add the two aforementioned extensions to your extensions list in your conf.py like so:

extensions = [
    'sphinxcontrib_robotdoc',
    'mlx.traceability',
]

Please read the documentation of mlx.traceability and LaTeX configuration for sphinxcontrib-robotdoc for additional configuration steps.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mlx.robot2rst, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size mlx.robot2rst-0.2.0-py2.py3-none-any.whl (9.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size mlx.robot2rst-0.2.0.tar.gz (13.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page