Changelog¶

Unreleased¶

Released:

under development

1.3.2¶

Released:

13.11.2025

This release improves Sphinx-Test-Reports compatibility with Sphinx and fixes some Sphinx related deprecation warnings.

• Bugfix: Fix deprecation warnings with Sphinx 8. #128

1.3.1¶

Released:

02.10.2025

Full Changelog:

v1.3.0…v1.3.1

• Support Sphinx-Needs 6 schema validation #122

1.3.0¶

Released:

28.09.2025

This release makes Sphinx-Test-Reports compatible with Sphinx-Needs 5.1 and introduces several maintenance improvements.

• Improvement: Support for Sphinx-Needs 5.1. #119

• Bugfix: Fix plantuml on RTD. #115

• Maintenance: Removed py38 from classifiers. #116

• Maintenance: Activate mypy. #113

• Maintenance: Remove baumpfleger. #112

• Maintenance: Clean makefile. #111

• Maintenance: Use flit. #110

• Maintenance: Added all_good job. #109

• Maintenance: Add standard hooks. #106

• Maintenance: Add yamlfmt. #105

• Maintenance: Introduce ruff. #104

• Maintenance: Add taplo pre-commit. #103

1.2.0¶

Released:

27.03.2025

• Improvement: Introducing tr_extra_options for setting custom options in all derrived test-cases from test-file and co. #96

• Improvement: JSON-Parser allows to set custom options in test-cases, like status or even id. See tr_json_mapping for examples. #99

1.1.0¶

Released:

17.01.2025

• Bugfix: Compatible with Sphinx-Needs >= 4.0.

• Bugfix: Path handling is os independent.

• Improvement: Referenced target_option in tr_link can contain a comma separated list.

• Improvement: The new JSON Parser is introduced.

• Improvement: Template file encoding could be configured. See tr_import_encoding. #60

• Improvement: Supporting JSON files containing test results: JSON Parser.

• Improvement: Implemented tr_json_mapping config option for JSON mapping.

1.0.2¶

Released:

21.12.2022 🎄

• Bugfix: Links in test-suite and co. do not raise error. #51

• Improvement: Allows empty text and message fields, which allows integration of ctest junit files #49

1.0.1¶

Released:

04.11.2022

• Improvement: ID length can be configured to avoid conflicts. See tr_suite_id_length and tr_case_id_length. #45

• Bugfix: Multiple testsuites get documented correctly. #40

1.0.0¶

Released:

26.09.2022

• Improvement: Supporting Sphinx-Needs >= 1.01 only.

• Improvement: Migrated nosetests to pytest.

0.3.7¶

Released:

09.06.2022

• Improvement: Nested test suites are supported (like in Robot Framework 5.0) #30

0.3.6¶

Released:

12.11.2021

• Improvement: Added support for parallel modes. #20

• Improvement: Support getting skipped tests. #18

0.3.5¶

Released:

18.06.2021

• Bugfix: Minor bugfixes

0.3.4¶

Released:

30.04.2021 (Recalled, contains major bugs)

• Bugfix: Removed Sphinx 4 deprecation warnings

0.3.3¶

• Improvement: Added test-report directive.

• Improvement: Introduces tr_file, tr_suite and tr_case options to customize names.

• Improvement: Not found files will throw warning instead of exception so that build goes on.

• Improvement: Provides css_classes tr_passed, tr_failure, tr_skipped to colorize needs and their rows in tables.

• Bugfix: Stabilised extension initialisation phase.

0.3.1¶

• Improvement: Support of case and table colors based on result.

• Bugfix: Hash-Id for autogenerated test-cases size was increased.

0.3.0¶

• Improvement: Using sphinx-needs for data representation and filtering.

• Improvement: New directives test-file, test-suite and test-case.

• Improvement: New possibilities to filter test data.

• Improvement: Much better documentation.

0.2.1¶

• Skipped support für Python < 3.5.

• Bugfix: junit-file-format of pytest > 5.1.0 supported. #8

0.2.0¶

Initial start for the changelog

• Improvement: added directive :test-env: to take tox-envreport.json as input and create a table.