:hide-navigation:
Installation
============
Install ``Sphinx-Test-Report`` via ``pip install sphinx-test-reports``.
After that the extension must to be added to the ``conf.py`` file::
extensions = ['sphinx_needs',
'sphinxcontrib.test_reports',
'sphinxcontrib.plantuml']
Please note, ``Sphinx-Test-Report`` is based on the
`Sphinx-needs extension `_.
Therefore it must also be added to the ``extensions`` list!
And same for `PlantUML `_, which is important to render flowcharts for filtered
test-cases.
More details can be find in the
`installation-guide `_
of ``Sphinx-Needs``.