Upgrade python requirements and remove all warnings (#747)

* Refs #20631. Update requirements and fix warnings Signed-off-by: Ricardo González Moreno <[email protected]> Signed-off-by: eduponz <[email protected]> * Refs #20631. Add support for CMAKE_COMPILE_WARNING_AS_ERROR Signed-off-by: Ricardo González Moreno <[email protected]> Signed-off-by: eduponz <[email protected]> * Refs #20631. Fix getting fastdds branch in readthedocs Signed-off-by: Ricardo González Moreno <[email protected]> Signed-off-by: eduponz <[email protected]> * Refs #20631. Move note by suggestion Signed-off-by: Ricardo González Moreno <[email protected]> Signed-off-by: eduponz <[email protected]> * Refs #20631. Fix idl Signed-off-by: Ricardo González Moreno <[email protected]> Signed-off-by: eduponz <[email protected]> * Refs #20631. Remove forgotten lines Signed-off-by: Ricardo González Moreno <[email protected]> Signed-off-by: eduponz <[email protected]> * Refs #20631. Fixes Signed-off-by: Ricardo González Moreno <[email protected]> Signed-off-by: eduponz <[email protected]> * Refs #20631: Avoid duplicated transport_id in XMLTester Signed-off-by: eduponz <[email protected]> --------- Signed-off-by: Ricardo González Moreno <[email protected]> Signed-off-by: eduponz <[email protected]> Co-authored-by: eduponz <[email protected]>
eProsima · May 14, 2024 · 7fd5e1c · 7fd5e1c
1 parent ef27e2b
commit 7fd5e1c
Show file tree

Hide file tree

Showing 75 changed files with 244 additions and 177 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -29,6 +29,11 @@ string(REGEX REPLACE "^version = u'([0-9]+.[0-9]+.[0-9]+)'"
 
 project(fastdds-docs VERSION "${LIB_VERSION_STR}" LANGUAGES C CXX)
 
+# In case CMake version less than 3.24, add the option CMAKE_COMPILE_WARNING_AS_ERROR.
+if (${CMAKE_VERSION} VERSION_LESS "3.24")
+    option(CMAKE_COMPILE_WARNING_AS_ERROR "Treat warnings as errors" OFF)
+endif()
+
 
 ####################################################################################################
 # Build Doxygen documentation
@@ -125,7 +130,9 @@ if (BUILD_DOCUMENTATION)
     # Generate the sphinx documentation
     add_custom_target(Sphinx ALL
         COMMAND
-        ${SPHINX_EXECUTABLE} -b ${FASTDDS_DOCS_BUILDER}
+        ${SPHINX_EXECUTABLE}
+        $<$<BOOL:${CMAKE_COMPILE_WARNING_AS_ERROR}>:-W>
+        -b ${FASTDDS_DOCS_BUILDER}
         # Tell Breathe where to find the Doxygen output
         -D breathe_projects.FastDDS=${DOXYGEN_OUTPUT_DIR}/xml
         ${PYTHON_EXTRA_FLAG}

diff --git a/code/DynamicTypesIDLExamples.idl b/code/DynamicTypesIDLExamples.idl
@@ -110,7 +110,7 @@ struct AliasStruct
 //!--IDL_SEQUENCES
 struct SequenceStruct
 {
-    sequence<MyBitmask> bitmask_sequence;
+    sequence<MyBitMask> bitmask_sequence;
     sequence<short, 5> short_sequence;
 };
 //!--
@@ -132,18 +132,18 @@ struct MapStruct
 
 //!--IDL_STRUCT
 struct InnerStruct
-{	
+{
     @id(0x10) long first;
 };
 
 struct ParentStruct
-{	
+{
     float first;
     long long second;
 };
 
 struct ComplexStruct : ParentStruct
-{	
+{
     InnerStruct complex_member;
 };
 //!--
@@ -170,7 +170,7 @@ union ComplexUnion switch (long)
 
 //!--IDL_BITSET
 bitset ParentBitSet
-{	
+{
     bitfield<3> a;
     bitfield<1> b;
     bitfield<4>;
@@ -179,7 +179,7 @@ bitset ParentBitSet
 };
 
 bitset ChildBitSet : ParentBitSet
-{	
+{
     bitfield<1> e;
     bitfield<20, unsigned long> f;
 };

diff --git a/code/XMLTester.xml b/code/XMLTester.xml
@@ -245,7 +245,7 @@
 <!-->CONF-COMMON-RECEPTION-THREADS-SETTINGS<-->
 <transport_descriptors>
     <transport_descriptor>
-        <transport_id>Test</transport_id>
+        <transport_id>test_transport</transport_id>
         <type>UDPv4</type>
         <reception_threads>
             <reception_thread port="20000">

diff --git a/colcon.meta b/colcon.meta
@@ -1,11 +1,12 @@
 names:
     fastdds:
         cmake-args:
-            - "-DSECURITY=ON"
+            - -DSECURITY=ON
     fastdds_python:
         cmake-args:
-            - "-DBUILD_DOCUMENTATION=ON"
+            - -DBUILD_DOCUMENTATION=ON
     fastdds-docs:
         cmake-args:
-            - "-DBUILD_DOCUMENTATION=ON"
-            - "-DCOMPILE_TESTS=ON"
+            - -DBUILD_DOCUMENTATION=ON
+            - -DCMAKE_COMPILE_WARNING_AS_ERROR=ON
+            - -DCOMPILE_TESTS=ON
diff --git a/docs/conf.py b/docs/conf.py
@@ -102,7 +102,15 @@ def get_git_branch():
     # Invoke git to get the current branch which we use to get the theme
     try:
         p = subprocess.Popen(
-            ['git', 'rev-parse', '--abbrev-ref', 'HEAD'],
+            ['git', 'rev-parse', '--verify', 'HEAD'],
+            stdout=subprocess.PIPE,
+            cwd=path_to_here
+        )
+
+        commit = p.communicate()[0].decode().rstrip()
+
+        p = subprocess.Popen(
+            ['git', 'name-rev', '--name-only', commit],
             stdout=subprocess.PIPE,
             cwd=path_to_here
         )

diff --git a/docs/fastdds/api_reference/api_reference.rst b/docs/fastdds/api_reference/api_reference.rst
@@ -15,9 +15,10 @@ For more information about the API reference, please refer to
 `Fast DDS API reference <https://www.eprosima.com/docs/fast-rtps/latest/API>`_.
 
 .. toctree::
+    :titlesonly:
 
-   /fastdds/api_reference/dds_pim/dds_pim
-   /fastdds/api_reference/rtps/rtps
-   /fastdds/api_reference/transport/transport
-   /fastdds/api_reference/log/log
-   /fastdds/api_reference/statistics/statistics
+    /fastdds/api_reference/dds_pim/dds_pim
+    /fastdds/api_reference/rtps/rtps
+    /fastdds/api_reference/transport/transport
+    /fastdds/api_reference/log/log
+    /fastdds/api_reference/statistics/statistics
diff --git a/docs/fastdds/api_reference/dds_pim/core/condition/basecondition.rst b/docs/fastdds/api_reference/dds_pim/core/condition/basecondition.rst
@@ -2,6 +2,7 @@ Condition
 =========
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/dds_pim/core/condition/condition.rst
     /fastdds/api_reference/dds_pim/core/condition/conditionseq.rst

diff --git a/docs/fastdds/api_reference/dds_pim/core/core.rst b/docs/fastdds/api_reference/dds_pim/core/core.rst
@@ -2,6 +2,7 @@ Core
 ====
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/core/entity.rst
    /fastdds/api_reference/dds_pim/core/domainentity.rst

diff --git a/docs/fastdds/api_reference/dds_pim/core/policy/policy.rst b/docs/fastdds/api_reference/dds_pim/core/policy/policy.rst
@@ -2,6 +2,7 @@ Policy
 ======
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/core/policy/datarepresentationid.rst
    /fastdds/api_reference/dds_pim/core/policy/datarepresentationqospolicy.rst

diff --git a/docs/fastdds/api_reference/dds_pim/core/status/status.rst b/docs/fastdds/api_reference/dds_pim/core/status/status.rst
@@ -2,6 +2,7 @@ Status
 ======
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/core/status/basestatus.rst
    /fastdds/api_reference/dds_pim/core/status/deadlinemissedstatus.rst

diff --git a/docs/fastdds/api_reference/dds_pim/dds_pim.rst b/docs/fastdds/api_reference/dds_pim/dds_pim.rst
@@ -6,6 +6,7 @@ DDS DCPS PIM
 Data Distribution Service (DDS) Data-Centric Publish-Subscribe (DCPS) Platform Independent Model (PIM) API
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/core/core.rst
    /fastdds/api_reference/dds_pim/domain/domain.rst

diff --git a/docs/fastdds/api_reference/dds_pim/domain/domain.rst b/docs/fastdds/api_reference/dds_pim/domain/domain.rst
@@ -2,6 +2,7 @@ Domain
 ======
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/domain/domainparticipant.rst
    /fastdds/api_reference/dds_pim/domain/domainparticipantfactory.rst

diff --git a/docs/fastdds/api_reference/dds_pim/publisher/publisher.rst b/docs/fastdds/api_reference/dds_pim/publisher/publisher.rst
@@ -2,6 +2,7 @@ Publisher
 =========
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/publisher/datawriter.rst
    /fastdds/api_reference/dds_pim/publisher/datawriterlistener.rst

diff --git a/docs/fastdds/api_reference/dds_pim/subscriber/subscriber.rst b/docs/fastdds/api_reference/dds_pim/subscriber/subscriber.rst
@@ -2,6 +2,7 @@ Subscriber
 ==========
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/subscriber/datareader.rst
    /fastdds/api_reference/dds_pim/subscriber/datareaderlistener.rst

diff --git a/docs/fastdds/api_reference/dds_pim/topic/topic.rst b/docs/fastdds/api_reference/dds_pim/topic/topic.rst
@@ -2,6 +2,7 @@ Topic
 =====
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/topic/topicdatatype.rst
    /fastdds/api_reference/dds_pim/topic/typesupport.rst

diff --git a/docs/fastdds/api_reference/dds_pim/xtypes/dynamic_types.rst b/docs/fastdds/api_reference/dds_pim/xtypes/dynamic_types.rst
@@ -4,6 +4,7 @@ Dynamic Language Binding
 ========================
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/xtypes/annotationdescriptor.rst
    /fastdds/api_reference/dds_pim/xtypes/dynamicdata.rst

diff --git a/docs/fastdds/api_reference/dds_pim/xtypes/type_representation.rst b/docs/fastdds/api_reference/dds_pim/xtypes/type_representation.rst
@@ -2,6 +2,7 @@ Type Representation
 ===================
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/xtypes/typeobjectregistry.rst
    /fastdds/api_reference/dds_pim/xtypes/typeobjectutils.rst
diff --git a/docs/fastdds/api_reference/dds_pim/xtypes/xtypes.rst b/docs/fastdds/api_reference/dds_pim/xtypes/xtypes.rst
@@ -2,6 +2,7 @@ XTypes
 ======
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/dds_pim/xtypes/dynamic_types.rst
    /fastdds/api_reference/dds_pim/xtypes/exception.rst

diff --git a/docs/fastdds/api_reference/log/colors.rst b/docs/fastdds/api_reference/log/colors.rst
@@ -6,5 +6,6 @@ Colors
 A collection of macros for ease the stream coloring.
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/log/colors/colors.rst
diff --git a/docs/fastdds/api_reference/log/log.rst b/docs/fastdds/api_reference/log/log.rst
@@ -6,6 +6,7 @@ LOG
 *eProsima Fast DDS* Logging Module API
 
 .. toctree::
+   :titlesonly:
 
    /fastdds/api_reference/log/colors.rst
    /fastdds/api_reference/log/file_consumer.rst

diff --git a/docs/fastdds/api_reference/rtps/attributes/attributes.rst b/docs/fastdds/api_reference/rtps/attributes/attributes.rst
@@ -4,6 +4,7 @@ Attributes
 ============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/attributes/BuiltinAttributes
     /fastdds/api_reference/rtps/attributes/c_default_RTPSParticipantAllocationAttributes

diff --git a/docs/fastdds/api_reference/rtps/builtin/data/data.rst b/docs/fastdds/api_reference/rtps/builtin/data/data.rst
@@ -4,5 +4,6 @@ Builtin data
 ============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/builtin/data/ContentFilterProperty
diff --git a/docs/fastdds/api_reference/rtps/common/BinaryProperty/binaryproperty_toc.rst b/docs/fastdds/api_reference/rtps/common/BinaryProperty/binaryproperty_toc.rst
@@ -4,6 +4,7 @@ BinaryProperty
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/BinaryProperty/BinaryProperty
     /fastdds/api_reference/rtps/common/BinaryProperty/BinaryPropertyHelper

diff --git a/docs/fastdds/api_reference/rtps/common/CDRMessage_t/cdrmessage_toc.rst b/docs/fastdds/api_reference/rtps/common/CDRMessage_t/cdrmessage_toc.rst
@@ -4,6 +4,7 @@ CDRMessage
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/CDRMessage_t/CDRMessage_t
     /fastdds/api_reference/rtps/common/CDRMessage_t/defines
diff --git a/docs/fastdds/api_reference/rtps/common/CacheChange/cachechange_toc.rst b/docs/fastdds/api_reference/rtps/common/CacheChange/cachechange_toc.rst
@@ -4,6 +4,7 @@ CacheChange
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/CacheChange/CacheChange_t
     /fastdds/api_reference/rtps/common/CacheChange/ChangeForReader_t

diff --git a/docs/fastdds/api_reference/rtps/common/EntityId_t/entityid_toc.rst b/docs/fastdds/api_reference/rtps/common/EntityId_t/entityid_toc.rst
@@ -4,9 +4,9 @@ EntityId
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/EntityId_t/const_values
     /fastdds/api_reference/rtps/common/EntityId_t/defines
     /fastdds/api_reference/rtps/common/EntityId_t/EntityId_t
     /fastdds/api_reference/rtps/common/EntityId_t/operators
-
diff --git a/docs/fastdds/api_reference/rtps/common/FragmentNumber/fragmentnumber_toc.rst b/docs/fastdds/api_reference/rtps/common/FragmentNumber/fragmentnumber_toc.rst
@@ -4,6 +4,7 @@ FragmentNumber
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/FragmentNumber/FragmentNumber_t
     /fastdds/api_reference/rtps/common/FragmentNumber/FragmentNumberSet_t
diff --git a/docs/fastdds/api_reference/rtps/common/Guid/guid_toc.rst b/docs/fastdds/api_reference/rtps/common/Guid/guid_toc.rst
@@ -4,6 +4,7 @@ Guid
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/Guid/c_Guid_Unknown
     /fastdds/api_reference/rtps/common/Guid/GUID_t

diff --git a/docs/fastdds/api_reference/rtps/common/GuidPrefix_t/guidprefix_toc.rst b/docs/fastdds/api_reference/rtps/common/GuidPrefix_t/guidprefix_toc.rst
@@ -4,6 +4,7 @@ GuidPrefix
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/GuidPrefix_t/c_GuidPrefix_Unknown
     /fastdds/api_reference/rtps/common/GuidPrefix_t/GuidPrefix_t

diff --git a/docs/fastdds/api_reference/rtps/common/InstanceHandle/instancehandle_toc.rst b/docs/fastdds/api_reference/rtps/common/InstanceHandle/instancehandle_toc.rst
@@ -4,6 +4,7 @@ InstanceHandle
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/InstanceHandle/c_InstanceHandle_Unknown
     /fastdds/api_reference/rtps/common/InstanceHandle/InstanceHandle_t

diff --git a/docs/fastdds/api_reference/rtps/common/Locator/locator_toc.rst b/docs/fastdds/api_reference/rtps/common/Locator/locator_toc.rst
@@ -4,6 +4,7 @@ Locator
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/Locator/defines
     /fastdds/api_reference/rtps/common/Locator/IsAddressDefined

diff --git a/docs/fastdds/api_reference/rtps/common/MatchingInfo/matchinginfo_toc.rst b/docs/fastdds/api_reference/rtps/common/MatchingInfo/matchinginfo_toc.rst
@@ -4,6 +4,7 @@ MatchingInfo
 ------------
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/MatchingInfo/MatchingInfo
     /fastdds/api_reference/rtps/common/MatchingInfo/MatchingStatus
diff --git a/docs/fastdds/api_reference/rtps/common/Property/property_toc.rst b/docs/fastdds/api_reference/rtps/common/Property/property_toc.rst
@@ -4,6 +4,7 @@ Property
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/Property/Property
     /fastdds/api_reference/rtps/common/Property/PropertyHelper

diff --git a/docs/fastdds/api_reference/rtps/common/RemoteLocators/remotelocators_toc.rst b/docs/fastdds/api_reference/rtps/common/RemoteLocators/remotelocators_toc.rst
@@ -4,6 +4,7 @@ RemoteLocators
 ===============
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/RemoteLocators/operators
     /fastdds/api_reference/rtps/common/RemoteLocators/RemoteLocatorList
diff --git a/docs/fastdds/api_reference/rtps/common/SequenceNumber/sequencenumber_toc.rst b/docs/fastdds/api_reference/rtps/common/SequenceNumber/sequencenumber_toc.rst
@@ -4,6 +4,7 @@ SequenceNumber
 ---------------
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/SequenceNumber/c_SequenceNumber_Unknown
     /fastdds/api_reference/rtps/common/SequenceNumber/operators

diff --git a/docs/fastdds/api_reference/rtps/common/SerializedPayload/serializedpayload_toc.rst b/docs/fastdds/api_reference/rtps/common/SerializedPayload/serializedpayload_toc.rst
@@ -4,6 +4,7 @@ SerializedPayload
 -------------------
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/SerializedPayload/defines
     /fastdds/api_reference/rtps/common/SerializedPayload/SerializedPayload_t
diff --git a/docs/fastdds/api_reference/rtps/common/Time_t/time_toc.rst b/docs/fastdds/api_reference/rtps/common/Time_t/time_toc.rst
@@ -4,6 +4,7 @@ Time_t
 --------------------
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/Time_t/const_values
     /fastdds/api_reference/rtps/common/Time_t/defines

diff --git a/docs/fastdds/api_reference/rtps/common/Token/token_toc.rst b/docs/fastdds/api_reference/rtps/common/Token/token_toc.rst
@@ -4,6 +4,7 @@ Token
 --------------------
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/Token/AuthenticatedPeerCredentialToken
     /fastdds/api_reference/rtps/common/Token/DataHolder

diff --git a/docs/fastdds/api_reference/rtps/common/Types/types_toc.rst b/docs/fastdds/api_reference/rtps/common/Types/types_toc.rst
@@ -4,6 +4,7 @@ Types
 --------------------
 
 .. toctree::
+    :titlesonly:
 
     /fastdds/api_reference/rtps/common/Types/BuiltinEndpointSet_t
     /fastdds/api_reference/rtps/common/Types/const_values