Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document feature: Color the results of a testcase #46

Merged
merged 9 commits into from
Jan 12, 2024
14 changes: 14 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,3 +212,17 @@ This requires you to configure the relationship `ext_robotframeworklog` in your
.. _Free test suite metadata: http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#free-test-suite-metadata
.. _html_extra_path: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path
.. _external relationship: https://melexis.github.io/sphinx-traceability-extension/configuration.html#external-relationship-to-url-translation

Color Test Results
==================

Use the stylesheet_ get a background color for the test results (pass, fail and skip)
in the generated HTML documentation of the test case.
This feature is used in the `test reports`_.

You can use the stylesheet_ by adding it with `add_css_file`_ or by adding it
manually in you own stylesheet.
JokeWaumans marked this conversation as resolved.
Show resolved Hide resolved

.. _test reports: https://melexis.github.io/xunit2rst/generated/itest_report.html#test-reports
.. _add_css_file: https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_css_file
.. _stylesheet: doc/source/_static/xunit2rst.css
JasperCraeghs marked this conversation as resolved.
Show resolved Hide resolved