Skip to content

Commit

Permalink
Add documentation color test results to README
Browse files Browse the repository at this point in the history
  • Loading branch information
JokeWaumans committed Jan 11, 2024
1 parent 8488495 commit 505c95b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,3 +212,16 @@ 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](doc/source/_static/xunit2rst.css) 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](doc/source/_static/xunit2rst.css) by adding it with `add_css_file`_ or by adding it
manually in you own stylesheet.

.. _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

0 comments on commit 505c95b

Please sign in to comment.