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.

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.

Source Distribution

mlx.robot2rst-0.1.0.tar.gz (13.1 kB view hashes)

Uploaded Source

Built Distribution

mlx.robot2rst-0.1.0-py2.py3-none-any.whl (9.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page