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:
- Source code: https://github.com/bli74/robotframework-doc-only
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file robotframework-doc-only-0.1.1.tar.gz.
File metadata
- Download URL: robotframework-doc-only-0.1.1.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d1665f54a443feba57b9ef505e69bff271798d9995b352704553e36c2cb1f6db |
|
| MD5 | b30e536b04e41afd500b6df9e4b8c681 |
|
| BLAKE2b-256 | 4222a5242e3fa031969f15f4197bfb3ecd03323dfe62ac67d950d59fe493cb3e |
File details
Details for the file robotframework_doc_only-0.1.1-py3-none-any.whl.
File metadata
- Download URL: robotframework_doc_only-0.1.1-py3-none-any.whl
- Upload date:
- Size: 8.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6fc62822c131f2050c526e5d56cf6e8261fe5fefe5132d13f336d3878631c891 |
|
| MD5 | 64e6c51f8c73104970272311cb9658f8 |
|
| BLAKE2b-256 | a8624628bcef65ea553d650af58793836efb308c31baffd7e31e337e18caaee2 |
