Skip to main content

Create test documentation without technical details

Project description

Welcome to Robot Framework Doc Only

Motivation

Robotframework offers module robot.testdoc to generate an HTML documentation of the testcases. This documentation includes technical details, that may not be relevant for readers, who are just interested in the business cases covered by the tests.

Additionally robot does not install a shell script to call testdoc directly. That is different to the similar tool libdoc for keyword documentation.

Getting started

    $ pip install robotframework-doc-only
    $ testdoc_small ${ROBOT_TEST_ROOT} ${DOCU_HTML_FILE}
    # OR
    $ testdoc_full ${ROBOT_TEST_ROOT} ${DOCU_HTML_FILE}

Websites

Source code, screenshots, and additional documentation can be found here:

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

robotframework-doc-only-0.1.1.tar.gz (7.0 kB view hashes)

Uploaded Source

Built Distribution

robotframework_doc_only-0.1.1-py3-none-any.whl (8.4 kB view hashes)

Uploaded 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