Refs #22788: Apply review changes and corrections for tests

Signed-off-by: Javier Gil Aviles <javiergil@eprosima.com>

Author: Javier Gil Aviles

.github/docker/ddsenabler/Dockerfile

@@ -61,7 +61,7 @@ RUN mkdir src && \
     cd src/ddspipe && git checkout ${ddspipe_branch} && cd ../.. && \
     cd src/ddsenabler && git checkout ${ddsenabler_branch} && cd ../.. && \
     cp -r src/fastdds/examples/cpp/configuration src/. && \
-    colcon build --packages-skip ddsenabler --event-handlers console_direct+ --cmake-args -DLOG_INFO=ON -DSECURITY=ON && \
+    colcon build --packages-skip ddsenabler ddsenabler_docs --event-handlers console_direct+ --cmake-args -DLOG_INFO=ON -DSECURITY=ON && \
     colcon build --packages-select ddsenabler --event-handlers console_direct+ --cmake-args -DLOG_INFO=ON -DCOMPILE_EXAMPLES=ON
 
 COPY run.bash /root/run.bash

.github/workflows/reusable-ubuntu-ci.yml

@@ -199,3 +199,5 @@ jobs:
 
       - name: Python Linter
         uses: eProsima/eProsima-CI/ubuntu/python_linter@v0
+        with:
+            file_extensions_grep_args: "-e '^(?!ddsenabler_docs/).+\\.py$'"

.gitignore

@@ -56,8 +56,11 @@ log/
 .vscode
 
 ### Documentation ###
-docs/rst/_static/css/online_eprosima_rtd_theme.css
-
+ddsenabler_docs/docs/rst/_static/css/online_eprosima_rtd_theme.css
+ddsenabler_docs/docs/_static/css/eprosima-furo.css
+ddsenabler_docs/docs/_static/eprosima-logo-white.png
+ddsenabler_docs/docs/_static/dds-enabler-logo.png
+ddsenabler_docs/docs/_templates/sidebar/commercial-support.html
 
 ### Python ###
 # Precompile files

README.md

@@ -40,26 +40,27 @@
 - **Flexible YAML Configuration**
   Fine-tune QoS, network filters, topic allow-listing/deny-listing and discovery via a human-readable YAML file.
 - **Dynamic Types via XTypes**
-  Leverage `OMG DDS-XTypes 1.3 <https://www.omg.org/spec/DDS-XTypes/1.3>`_ and Fast DDS serialization utilities for runtime type registration and discovery.
+Leverage [OMG DDS-XTypes 1.3](https://www.omg.org/spec/DDS-XTypes/1.3) and Fast DDS serialization utilities for runtime type registration and discovery.
 - **Core Engine Powered by DDS-Pipe**
-  Built on `eProsima DDS Pipe <https://github.com/eProsima/DDS-Pipe>`_, ensuring low-latency, high-throughput payload forwarding and reliable discovery across distributed systems.
+  Built on [eProsima DDS Pipe](https://github.com/eProsima/DDS-Pipe), ensuring low-latency, high-throughput payload forwarding and reliable discovery across distributed systems.
 - **Serialization Utilities**
-  Convert DDS data to JSON for REST integration and to human-readable IDL; JSON→DDS deserializer support is in development.
+  Convert DDS data to JSON and vice versa for REST integration and to human-readable IDL.
 - **Bidirectional FIWARE Integration**
   Routes DDS samples to NGSI-LD Context Brokers and injects context updates back into DDS topics.
 
 ![DDS Enabler Architecture](docs/rst/figures/ddsenabler_architecture.png)
 
 ## Commercial support
 
-Looking for professional support or custom integration?
-Contact us at **info@eprosima.com** or raise an issue on GitHub.
+Looking for commercial support? Write us to info@eprosima.com
+
+Find more about us at [eProsima’s webpage](https://eprosima.com/).
 
 ## Documentation
 
-Explore the full user and developer guide hosted on Read the Docs:
+Explore the full user and developer guide hosted on ReadTheDocs:
 
-- [Introduction](https://dds-enabler.readthedocs.io/en/latest/rst/formalia/titlepage.html)
+- [Introduction](https://dds-enabler.readthedocs.io/en/latest/rst/02-formalia/titlepage.html)
 - [Project Overview](https://dds-enabler.readthedocs.io/en/latest/rst/getting_started/project_overview.html)
 - [User Manual](https://dds-enabler.readthedocs.io/en/latest/rst/user_manual/context_broker_interface.html)
 - [API Reference](https://dds-enabler.readthedocs.io/en/latest/rst/ddsenabler/api_reference/api_reference.html)

ddsenabler_docs/CMakeLists.txt

@@ -45,90 +45,75 @@ project(
 ####################################################################################################
 # Build Doxygen documentation
 ####################################################################################################
-
-find_package(ddsenabler REQUIRED)
-get_target_property(ENABLER_INCLUDE_DIR ddsenabler INTERFACE_INCLUDE_DIRECTORIES)
-
-find_package(ddsenabler_participants REQUIRED)
-get_target_property(PARTICIPANTS_INCLUDE_DIR ddsenabler_participants INTERFACE_INCLUDE_DIRECTORIES)
-
-message(STATUS "DDS Enabler include directories: ${ENABLER_INCLUDE_DIR} ; ${PARTICIPANTS_INCLUDE_DIR}")
-set(SRC_FILE "${PARTICIPANTS_INCLUDE_DIR}/ddsenabler_participants/CBCallbacks.hpp")
-set(DST_DIR "${ENABLER_INCLUDE_DIR}/ddsenabler")
-file(COPY ${SRC_FILE} DESTINATION ${DST_DIR})
-# Collect all public headers
-file(GLOB_RECURSE HPP_FILES
-    "${ENABLER_INCLUDE_DIR}/ddsenabler/**/*.h*"
-)
-
-find_package(Doxygen REQUIRED)
-# Create doxygen directories
-add_custom_target(doc-dirs
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/doxygen
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/html
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/html/doxygen
-    COMMENT "Creating documentation directories" VERBATIM)
-
-# Doxygen related variables
-set(DOXYGEN_INPUT_DIR
-    "${ENABLER_INCLUDE_DIR}/ddsenabler"
-)
-# convert CMake list (;) to space-separated for Doxygen
-string(REPLACE ";" " " DOXYGEN_INPUT_DIR "${DOXYGEN_INPUT_DIR}")
-
-set(DOXYGEN_OUTPUT_DIR "${PROJECT_BINARY_DIR}/doxygen")
-set(DOXYGEN_INDEX_FILE "${PROJECT_BINARY_DIR}/doxygen/xml/index.xml")
-set(DOXYFILE_IN "${CMAKE_CURRENT_SOURCE_DIR}/code/Doxyfile.in")
-set(DOXYFILE_OUT ${PROJECT_BINARY_DIR}/Doxyfile)
-
-# Configure doxygen
-configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
-
-# Doxygen command
-add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
-    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
-    DEPENDS ${HPP_FILES}
-    MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN}
-    COMMENT "Generating doxygen documentation")
-
-# Generate API reference
-add_custom_target(doxygen ALL
-    DEPENDS ${DOXYGEN_INDEX_FILE}
-    COMMENT "Generated API documentation with doxygen" VERBATIM)
-add_dependencies(doxygen doc-dirs)
-
-# Install doxygen generated XML files
-install(DIRECTORY ${PROJECT_BINARY_DIR}/doxygen/xml
-    DESTINATION doxygen)
-
-
-####################################################################################################
-# Find Sphinx
-####################################################################################################
-set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/code/cmake" ${CMAKE_MODULE_PATH})
-find_package(Sphinx REQUIRED)
-
-####################################################################################################
-# Compile code used in documentation
-####################################################################################################
-# Option to compile documentation tests
-option(COMPILE_TESTS "Compile DDS Enabler docs tests" ON)
-if(COMPILE_TESTS)
-    # CTest needs to be included here, otherwise it is not possible to run the tests from the root
-    # of the build directory
-    enable_testing()
-    include(CTest)
-    add_subdirectory(code)
-endif()
-
-####################################################################################################
-# Build Sphinx documentation
-####################################################################################################
-# It is possible to build and run tests without generating the documentation output. This saves time
-# while developing, since generating the documentation from the RSTs takes quite some time.
-set(SPHINX_SOURCE "${CMAKE_SOURCE_DIR}/docs")
-option(BUILD_DOCUMENTATION "Generate documentation" ON)
-if (BUILD_DOCUMENTATION)
+if (BUILD_DOCS)
+    find_package(ddsenabler REQUIRED)
+    get_target_property(ENABLER_INCLUDE_DIR ddsenabler INTERFACE_INCLUDE_DIRECTORIES)
+
+    find_package(ddsenabler_participants REQUIRED)
+    get_target_property(PARTICIPANTS_INCLUDE_DIR ddsenabler_participants INTERFACE_INCLUDE_DIRECTORIES)
+
+    message(STATUS "DDS Enabler include directories: ${ENABLER_INCLUDE_DIR} ; ${PARTICIPANTS_INCLUDE_DIR}")
+    set(SRC_FILE "${PARTICIPANTS_INCLUDE_DIR}/ddsenabler_participants/CBCallbacks.hpp")
+    set(DST_DIR "${ENABLER_INCLUDE_DIR}/ddsenabler")
+    file(COPY ${SRC_FILE} DESTINATION ${DST_DIR})
+    # Collect all public headers
+    file(GLOB_RECURSE HPP_FILES
+        "${ENABLER_INCLUDE_DIR}/ddsenabler/**/*.h*"
+    )
+
+    find_package(Doxygen REQUIRED)
+    # Create doxygen directories
+    add_custom_target(doc-dirs
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/doxygen
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/html
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/html/doxygen
+        COMMENT "Creating documentation directories" VERBATIM)
+
+    # Doxygen related variables
+    set(DOXYGEN_INPUT_DIR
+        "${ENABLER_INCLUDE_DIR}/ddsenabler"
+    )
+    # convert CMake list (;) to space-separated for Doxygen
+    string(REPLACE ";" " " DOXYGEN_INPUT_DIR "${DOXYGEN_INPUT_DIR}")
+
+    set(DOXYGEN_OUTPUT_DIR "${PROJECT_BINARY_DIR}/doxygen")
+    set(DOXYGEN_INDEX_FILE "${PROJECT_BINARY_DIR}/doxygen/xml/index.xml")
+    set(DOXYFILE_IN "${CMAKE_CURRENT_SOURCE_DIR}/code/Doxyfile.in")
+    set(DOXYFILE_OUT ${PROJECT_BINARY_DIR}/Doxyfile)
+
+    # Configure doxygen
+    configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
+
+    # Doxygen command
+    add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
+        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
+        DEPENDS ${HPP_FILES}
+        MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN}
+        COMMENT "Generating doxygen documentation")
+
+    # Generate API reference
+    add_custom_target(doxygen ALL
+        DEPENDS ${DOXYGEN_INDEX_FILE}
+        COMMENT "Generated API documentation with doxygen" VERBATIM)
+    add_dependencies(doxygen doc-dirs)
+
+    # Install doxygen generated XML files
+    install(DIRECTORY ${PROJECT_BINARY_DIR}/doxygen/xml
+        DESTINATION doxygen)
+
+
+    ####################################################################################################
+    # Find Sphinx
+    ####################################################################################################
+    set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/code/cmake" ${CMAKE_MODULE_PATH})
+    find_package(Sphinx REQUIRED)
+
+    ####################################################################################################
+    # Build Sphinx documentation
+    ####################################################################################################
+    # It is possible to build and run tests without generating the documentation output. This saves time
+    # while developing, since generating the documentation from the RSTs takes quite some time.
+    set(SPHINX_SOURCE "${CMAKE_SOURCE_DIR}/docs")
 
     # CMake project always build the documentaion using HTML builder. Users can always build with
     # other builders using sphinx directly
@@ -159,3 +144,17 @@ if (BUILD_DOCUMENTATION)
         "eProsima DDS Enabler documetation in ${DDSENABLER_DOCS_BUILDER} format")
     set(CPACK_COMPONENTS_ALL ${CPACK_COMPONENTS_ALL} ${DDSENABLER_DOCS_BUILDER})
 endif()
+
+###############################################################################
+# Test
+###############################################################################
+# Compile tests if CMake options requires it
+compile_test_documentation(
+    "${PROJECT_SOURCE_DIR}/test" # Test directory
+)
+
+###############################################################################
+# Packaging
+###############################################################################
+# Install package
+eprosima_packaging()

ddsenabler_docs/docs/formalia/format.txt …enabler_docs/docs/02-formalia/format.txtddsenabler_docs/docs/formalia/format.txt renamed to ddsenabler_docs/docs/02-formalia/format.txt ddsenabler_docs/docs/formalia/format.txt renamed to ddsenabler_docs/docs/02-formalia/format.txt

@@ -44,22 +44,22 @@ Key characteristics include:
 - **Real-time publish-subscribe middleware**: Built on the DDS standard, enabling low-latency and reliable communication.
 - **Seamless OT/IT integration**: Acts as a translator between DDS-based systems and NGSI-LD context brokers.
 - **ROS 2 and FIWARE compatibility**: Enables industrial robots and context-aware applications to operate through the same infrastructure.
-- **Scalable and extensible architecture**: Fully compatible with modern I4.0 deployments, providing flexibility for growth and adaptation.
+- **Scalable and extensible architecture**: Fully compatible with modern Industry 5.0 deployments, providing flexibility for growth and adaptation.
 
 Under the hood, DDS Enabler also provides:
 
-- **Transparent DDS Management**
+- **Transparent DDS Management.**
   Auto-create and discover DomainParticipants, Publishers, Subscribers, topics and types without manual code.
-- **Flexible YAML Configuration**
+- **Flexible YAML Configuration.**
   Fine-tune QoS, network filters and discovery through a human-readable YAML file.
-- **Dynamic Types via XTypes**
+- **Dynamic Types via XTypes.**
   Leverage `OMG DDS-XTypes 1.3 <https://www.omg.org/spec/DDS-XTypes/1.3>`_ and Fast DDS serialization utilities for
   on-the-fly type registration.
-- **Core Engine Powered by DDS-Pipe**
+- **Core Engine Powered by DDS-Pipe.**
   Built on `eProsima DDS Pipe <https://github.com/eProsima/DDS-Pipe>`_, ensuring high throughput and reliable
   participant discovery.
-- **Serialization Utilities**
-  Convert DDS data to JSON and IDL strings, with JSON→DDS deserialization under development.
+- **Serialization Utilities.**
+  Convert DDS data to JSON and vice versa for REST integration and to human-readable IDL.
 
 DDS Enabler is a flagship component of the ARISE project:
 `ARISE Middleware <https://arise-middleware.eu/>`_.