diff --git a/doc/_static/css/custom.css b/doc/_static/css/custom.css index 5fc5a07..2fa774e 100644 --- a/doc/_static/css/custom.css +++ b/doc/_static/css/custom.css @@ -20,4 +20,9 @@ table p { table input { float: right !important; -} \ No newline at end of file +} + +.icon { + height: auto !important; + width: auto !important; +} diff --git a/doc/_static/img/DDS-logo-nobg.png b/doc/_static/img/DDS-logo-nobg.png new file mode 100644 index 0000000..610315c Binary files /dev/null and b/doc/_static/img/DDS-logo-nobg.png differ diff --git a/doc/_static/img/DDS-logo.jpg b/doc/_static/img/DDS-logo.jpg deleted file mode 100644 index b919b83..0000000 Binary files a/doc/_static/img/DDS-logo.jpg and /dev/null differ diff --git a/doc/_static/img/favicon.ico b/doc/_static/img/favicon.ico index f1946d2..20f73b3 100644 Binary files a/doc/_static/img/favicon.ico and b/doc/_static/img/favicon.ico differ diff --git a/doc/_static/img/show_all_test_suites.png b/doc/_static/img/show_all_test_suites.png new file mode 100644 index 0000000..5ba5d3e Binary files /dev/null and b/doc/_static/img/show_all_test_suites.png differ diff --git a/doc/conf.py b/doc/conf.py index 009b5d8..2b39e5b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -150,7 +150,7 @@ def setup(app): # documentation. # # html_theme_options = {} -html_logo = "_static/img/DDS-logo.jpg" +html_logo = "_static/img/DDS-logo-nobg.png" html_favicon = "_static/img/favicon.ico" html_css_files = ['css/custom.css'] html_js_files = ['js/custom.js'] diff --git a/doc/detailed_report.template.rst b/doc/detailed_report.template.rst index aaaf9c5..06adcaa 100644 --- a/doc/detailed_report.template.rst +++ b/doc/detailed_report.template.rst @@ -5,8 +5,36 @@ Detailed Report =============== -This is a placeholder for the detailed report -|INDEX_HTML_PATH| +This test report displays the individual test results for all products regarding +DDS interoperability. By default, it only shows the test suites that contain +tests with errors. For each test, the report includes detailed information about +the test case. If the test has failed, it also shows the observed error, and the +corresponding program output. + +|br| + +In order to show all test suites, you have to click on the 'Advanced Filter' / +'Suites' / 'Empty hidden'. As shown in the image: + +|br| + +.. image:: _static/img/show_all_test_suites.png + :alt: Show All Tests + :align: center + +|br| + +The name of the test suite contains two product names separated by 3 dashes. It +represents the product used as a publisher (element at the left) and the product +used as a subscriber (right side): + + * \---\ + +|br| + +Detailed report: + +|br| .. raw:: html :file: |INDEX_HTML_PATH| diff --git a/doc/index.rst b/doc/index.rst index 545e320..401e554 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -15,7 +15,6 @@ Welcome to |INTEROPERABILITY_TESTS| :glob: :caption: Contents - introduction test_results detailed_report copyright diff --git a/doc/introduction.rst b/doc/introduction.rst deleted file mode 100644 index 23accc8..0000000 --- a/doc/introduction.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. include:: vars.rst - -.. _section-introduction: - -Introduction -============ - -This is a placeholder for the introduction - -You can download the zip that contains all the info here: |LINK_ZIP_URL| \ No newline at end of file diff --git a/doc/test_results.template.rst b/doc/test_results.template.rst index f92a414..ccb3921 100644 --- a/doc/test_results.template.rst +++ b/doc/test_results.template.rst @@ -5,13 +5,24 @@ Test Results ============ -This is a placeholder for the test Results -|LINK_XLSX_URL| +This page contains a summary of test results for interoperability tests of the +Data Distribution Service® (DDS®) standard, performed using the Object +Management Group® (OMG®) interoperability tests available at +https://github.com/omg-dds/dds-rtps. -ASDFASDF +The test results are organized in the following a spreadsheet. The first tab +presents a comprehensive summary of the tests per product. The first table +delineates the number of passed tests versus total tests, offering a quick +overview of vendor compliance. The second table delineates the tests performed +between products acting as publishers and subscribers, providing insights into +interoperability between different product implementations. + +The subsequent tabs represent individual test results per product. Each tab is +named after the respective product and contains two tables: + + * the current product as publisher and all products as subscribers + * the current product as subscriber and all products as publishers .. raw:: html - -ASDFADSF \ No newline at end of file diff --git a/generate_xlsx_report.py b/generate_xlsx_report.py index ae974d5..5ccd7b4 100644 --- a/generate_xlsx_report.py +++ b/generate_xlsx_report.py @@ -712,7 +712,7 @@ def add_static_data_summary_worksheet(self, # Add DDS logo pic current_row += 2 script_folder = os.path.dirname(__file__) - dds_logo_path = os.path.join(script_folder, 'doc/static/img/DDS-logo.jpg') + dds_logo_path = os.path.join(script_folder, 'doc/static/img/DDS-logo-nobg.png') worksheet.insert_image( row=current_row, col=starting_column, filename=dds_logo_path,