robot2rst

What's Changed

• Convert to a namespace package and upgrade GitHub actions by @JasperCraeghs in https://github.com/melexis/robot2rst/pull/42

Full Changelog: https://github.com/melexis/robot2rst/compare/3.4.0...3.5.0

When you have only certain test cases that you want to include in your RST export (like for example when you only run certain tests in robotframework), then you want this to be reflected also in your Test Plan in reStructured text. The feature added enables you to do just that.

What's Changed

• Filter test cases on tags by @JasperCraeghs in https://github.com/melexis/robot2rst/pull/40

Full Changelog: https://github.com/melexis/robot2rst/compare/3.3.0...3.4.0

What's Changed

• Support special characters in test case names by @JasperCraeghs in https://github.com/melexis/robot2rst/pull/39

Full Changelog: https://github.com/melexis/robot2rst/compare/3.2.1...3.3.0

What's Changed

• Fix AttributeError introduced in 3.2.0 by @JasperCraeghs in https://github.com/melexis/robot2rst/pull/38

Full Changelog: https://github.com/melexis/robot2rst/compare/3.2.0...3.2.1

What's Changed

• Drop support for Python 3.6 and test 3.10 and 3.11 by @JasperCraeghs in https://github.com/melexis/robot2rst/pull/34
• Use output filename to generate a human readable title by @JasperCraeghs in https://github.com/melexis/robot2rst/pull/35
• Support the coverage option of the item-matrix directive by @JasperCraeghs in https://github.com/melexis/robot2rst/pull/36
• Resolve RF variables in Documentation by @JasperCraeghs in https://github.com/melexis/robot2rst/pull/37

Full Changelog: https://github.com/melexis/robot2rst/compare/3.1.0...3.2.0

• Added a new optional input argument --only EXPRESSION to conditionally exclude the entire content of the RST file from the documentation [PR #31]
• Improved error handling [PR #32]

According to ASPICE the software requirements should be tested by software qualification tests. With that we changed default integration test (and ITEST prefix) to qualification test. As this breaks backwards compatibility the major version is bumped.

The previous behavior can be achieved by passing --type i and --prefix ITEST- to the command line arguments.

What's Changed

• Use QTEST- and 'qualification' as the new defaults by @JasperCraeghs in https://github.com/melexis/robot2rst/pull/28

Full Changelog: https://github.com/melexis/robot2rst/compare/2.1.1...3.0.0

Functionally still the same as 2.1.0, except that 2.1.0 was never deployed to pypi because of CI issues.

While the output produced still requires mlx.traceability to be displayed nicely, the installation with such dependency has become quite big as it draws additional dependencies from the mlx.traceability. So we are dropping this from the package, but to use the reStructured Text output you will still need to install mlx.traceability for the Sphinx build.

Explicitly specify default value for group option of item-matrix and keep compatibility with mlx.traceability 7.0.0

Small bug fix for the error that gets thrown when a FOR-loop is encountered in a test case. Bug was introduced in version 2.0.0.

The text inside the documentation tag in robot file is now treated as reStructuredText syntax, which means indents and newlines are preserved. This enables your reStructuredText renderers to actually render bulleted lists or even plantuml diagrams for example.
Provide support for usage with robotframework 3.2 and higher.

• Do not generate traceability matrix when default tag regex '.*' is used as it does not make sense #15

• Allow empty optional arguments since default arguments can be used, which are all documented now.

• Only base output on test cases with documention in the item's body
• Multiple regexes are now supported to match different kind of tags and add a specific relationship for each kind of tag
• Added a traceability matrix for each tag regex, which is used as target
• Dropped dependency to sphinxcontrib-robotdoc Sphinx extension

• Added entry points robot2rst and mlx.robot2rst #9

• Added --trim-suffix flag, which, when enabled, trims the --tag and all prefix input arguments that end with _- so that this suffix gets changed to a - only. This flag is disabled by default.
• No longer output :validates: when no tags match regex of --tags .
• Allow --rst input argument to only be a file name without parent directory specified.