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.2.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

robotframework_doc_only-0.1.2-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file robotframework_doc_only-0.1.2.tar.gz.

File metadata

  • Download URL: robotframework_doc_only-0.1.2.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.23

File hashes

Hashes for robotframework_doc_only-0.1.2.tar.gz
Algorithm Hash digest
SHA256 4478c0045838d5d1c98bfe6a8e8e4d9e54d24739a1113997c8b3cfaa2f124cf4
MD5 a4d2767c92a4b456bdba1a3d9a5bef25
BLAKE2b-256 3bfcef6fb42c08592173906ae30c8d27273451d08bcf3e45056cfe0b826d1eda

See more details on using hashes here.

File details

Details for the file robotframework_doc_only-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for robotframework_doc_only-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b612b073adcf29ae154073d8c27a886f7f9f987a4e9f82f677fd9966e1ca4598
MD5 7cbbf81ea45506710f74daac5d5816f4
BLAKE2b-256 81be53a3b3cc246830aa4b22d849fc1a64bd3ae57cea0282b74e45c683342e70

See more details on using hashes here.

Supported by

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