diff --git a/CMakeLists.txt b/CMakeLists.txt index 50f8a5c8f..fac28bc0f 100644 --- 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} + $<$:-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 index 1c8336c82..596a8ea14 100644 --- a/code/DynamicTypesIDLExamples.idl +++ b/code/DynamicTypesIDLExamples.idl @@ -110,7 +110,7 @@ struct AliasStruct //!--IDL_SEQUENCES struct SequenceStruct { - sequence bitmask_sequence; + sequence bitmask_sequence; sequence 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 index de3183646..970b93161 100644 --- a/code/XMLTester.xml +++ b/code/XMLTester.xml @@ -245,7 +245,7 @@ CONF-COMMON-RECEPTION-THREADS-SETTINGS<--> - Test + test_transport UDPv4 diff --git a/colcon.meta b/colcon.meta index 42282605a..9324c6877 100644 --- 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 index bd8330e4a..9e7503132 100644 --- 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 index a4b2a270d..402985f93 100644 --- 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 `_. .. 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 index 97d0234fc..f276d1df4 100644 --- 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 index 94d4322f6..7f630005e 100644 --- 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 index 92189bdad..37f3c53e2 100644 --- 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 index 8926a1e52..584415520 100644 --- 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 index d5c54eaa5..a519e2b57 100644 --- 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 index bd2166289..818a7151c 100644 --- 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 index c81df86b6..5b25891dc 100644 --- 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 index 2e0276514..bf604a144 100644 --- 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 index 47be1cca3..e3eb2bb10 100644 --- 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 index 7288a4e8d..e6e1c4009 100644 --- 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 index 18299eaf9..b81a99066 100644 --- 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 index 60a0b16ad..8f4f4bbe3 100644 --- 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 index 96b6b7851..e4288fada 100644 --- 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 index 8909ae1e9..dc125d048 100644 --- 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 index 8f23a1541..1927fd789 100644 --- 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 index 6bedac849..3f0b02ef9 100644 --- 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 index 058f72143..bbb8f647b 100644 --- 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 index 7417319f4..619724593 100644 --- 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 index d6bbca20e..39e9a7b3c 100644 --- 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 index ed704a364..f05374b03 100644 --- 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 index 7d8def252..6b1430849 100644 --- 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 index 2ddaec66e..59330e527 100644 --- 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 index ce25ec29f..c79a67c3b 100644 --- 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 index a1d71076f..fcd9f8e6e 100644 --- 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 index 35030aee7..e6561fc5b 100644 --- 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 index 91d318dae..704ee8c00 100644 --- 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 index a04389842..6502f0963 100644 --- 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 index ca316315f..38f9dc94c 100644 --- 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 index 516f4ffc9..fe9e835cb 100644 --- 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 index 9b83626a1..b4791c440 100644 --- 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 index 4b86372f3..d094152dd 100644 --- 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 index e49a46d41..2292bd2a9 100644 --- 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 index f5d1bbbac..81af0ff0d 100644 --- 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 diff --git a/docs/fastdds/api_reference/rtps/common/common.rst b/docs/fastdds/api_reference/rtps/common/common.rst index e1ab1e8b4..2bb87bf21 100644 --- a/docs/fastdds/api_reference/rtps/common/common.rst +++ b/docs/fastdds/api_reference/rtps/common/common.rst @@ -4,6 +4,7 @@ Common ====== .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/common/BinaryProperty/binaryproperty_toc /fastdds/api_reference/rtps/common/CacheChange/cachechange_toc diff --git a/docs/fastdds/api_reference/rtps/exceptions/exceptions.rst b/docs/fastdds/api_reference/rtps/exceptions/exceptions.rst index 3bc6d4a57..187fc8be1 100644 --- a/docs/fastdds/api_reference/rtps/exceptions/exceptions.rst +++ b/docs/fastdds/api_reference/rtps/exceptions/exceptions.rst @@ -4,5 +4,6 @@ Exceptions ============ .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/exceptions/Exception diff --git a/docs/fastdds/api_reference/rtps/flowcontrol/flowcontrol.rst b/docs/fastdds/api_reference/rtps/flowcontrol/flowcontrol.rst index ce1c89455..a438171b5 100644 --- a/docs/fastdds/api_reference/rtps/flowcontrol/flowcontrol.rst +++ b/docs/fastdds/api_reference/rtps/flowcontrol/flowcontrol.rst @@ -4,6 +4,7 @@ Flow control ============ .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/flowcontrol/FlowControllerDescriptor /fastdds/api_reference/rtps/flowcontrol/FlowControllerSchedulerPolicy diff --git a/docs/fastdds/api_reference/rtps/history/history.rst b/docs/fastdds/api_reference/rtps/history/history.rst index 883b4849e..8b39cf0c7 100644 --- a/docs/fastdds/api_reference/rtps/history/history.rst +++ b/docs/fastdds/api_reference/rtps/history/history.rst @@ -4,11 +4,10 @@ History ============ .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/history/History_class /fastdds/api_reference/rtps/history/IChangePool /fastdds/api_reference/rtps/history/IPayloadPool /fastdds/api_reference/rtps/history/ReaderHistory /fastdds/api_reference/rtps/history/WriterHistory - - diff --git a/docs/fastdds/api_reference/rtps/participant/participant.rst b/docs/fastdds/api_reference/rtps/participant/participant.rst index 9b57a25ff..11dcaea49 100644 --- a/docs/fastdds/api_reference/rtps/participant/participant.rst +++ b/docs/fastdds/api_reference/rtps/participant/participant.rst @@ -4,6 +4,7 @@ RTPSParticipant ================= .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/participant/participantdiscoveryinfo/participantdiscoveryinfo /fastdds/api_reference/rtps/participant/RTPSParticipant diff --git a/docs/fastdds/api_reference/rtps/participant/participantdiscoveryinfo/participantdiscoveryinfo.rst b/docs/fastdds/api_reference/rtps/participant/participantdiscoveryinfo/participantdiscoveryinfo.rst index 0caf48cbf..a7b867851 100644 --- a/docs/fastdds/api_reference/rtps/participant/participantdiscoveryinfo/participantdiscoveryinfo.rst +++ b/docs/fastdds/api_reference/rtps/participant/participantdiscoveryinfo/participantdiscoveryinfo.rst @@ -4,6 +4,7 @@ ParticipantDiscoveryInfo ============================ .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/participant/participantdiscoveryinfo/ParticipantAuthenticationInfo /fastdds/api_reference/rtps/participant/participantdiscoveryinfo/ParticipantDiscoveryInfo_class diff --git a/docs/fastdds/api_reference/rtps/reader/reader.rst b/docs/fastdds/api_reference/rtps/reader/reader.rst index 20b4345ba..9a86955f0 100644 --- a/docs/fastdds/api_reference/rtps/reader/reader.rst +++ b/docs/fastdds/api_reference/rtps/reader/reader.rst @@ -4,6 +4,7 @@ RTPSReader ============ .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/reader/ReaderListener /fastdds/api_reference/rtps/reader/RTPSReader diff --git a/docs/fastdds/api_reference/rtps/resources/resources.rst b/docs/fastdds/api_reference/rtps/resources/resources.rst index f0881c43a..83f3969f9 100644 --- a/docs/fastdds/api_reference/rtps/resources/resources.rst +++ b/docs/fastdds/api_reference/rtps/resources/resources.rst @@ -4,5 +4,6 @@ Resources ============ .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/resources/MemoryManagementPolicy diff --git a/docs/fastdds/api_reference/rtps/rtps.rst b/docs/fastdds/api_reference/rtps/rtps.rst index 3b0f896ba..5e74c4f64 100644 --- a/docs/fastdds/api_reference/rtps/rtps.rst +++ b/docs/fastdds/api_reference/rtps/rtps.rst @@ -6,6 +6,7 @@ RTPS *eProsima Fast DDS* Real-Time Publish-Subscribe (RTPS) layer API. .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/attributes/attributes diff --git a/docs/fastdds/api_reference/rtps/writer/writer.rst b/docs/fastdds/api_reference/rtps/writer/writer.rst index f3bde7891..ca38c6cc0 100644 --- a/docs/fastdds/api_reference/rtps/writer/writer.rst +++ b/docs/fastdds/api_reference/rtps/writer/writer.rst @@ -4,6 +4,7 @@ RTPSWriter ============ .. toctree:: + :titlesonly: /fastdds/api_reference/rtps/writer/RTPSWriter.rst /fastdds/api_reference/rtps/writer/WriterListener.rst diff --git a/docs/fastdds/api_reference/statistics/statistics.rst b/docs/fastdds/api_reference/statistics/statistics.rst index 79c8b5e7b..4cea7ad69 100644 --- a/docs/fastdds/api_reference/statistics/statistics.rst +++ b/docs/fastdds/api_reference/statistics/statistics.rst @@ -6,6 +6,7 @@ Statistics *eProsima Fast DDS* Statistics Module extension API. .. toctree:: + :titlesonly: /fastdds/api_reference/statistics/domain_participant.rst /fastdds/api_reference/statistics/datawriter_qos.rst diff --git a/docs/fastdds/api_reference/transport/chaining_transport.rst b/docs/fastdds/api_reference/transport/chaining_transport.rst index 1d76a7da3..677becbff 100644 --- a/docs/fastdds/api_reference/transport/chaining_transport.rst +++ b/docs/fastdds/api_reference/transport/chaining_transport.rst @@ -2,6 +2,7 @@ Chaining of transports ====================== .. toctree:: + :titlesonly: /fastdds/api_reference/transport/chaining_transport/chaining_transport_descriptor.rst /fastdds/api_reference/transport/chaining_transport/chaining_transport.rst diff --git a/docs/fastdds/api_reference/transport/shm_transport_interface.rst b/docs/fastdds/api_reference/transport/shm_transport_interface.rst index 4a53ce00d..0905938e0 100644 --- a/docs/fastdds/api_reference/transport/shm_transport_interface.rst +++ b/docs/fastdds/api_reference/transport/shm_transport_interface.rst @@ -2,5 +2,6 @@ Shared Memory Transport ======================= .. toctree:: + :titlesonly: /fastdds/api_reference/transport/shm_transport/shared_mem_transport_descriptor.rst diff --git a/docs/fastdds/api_reference/transport/tcp_transport_interface.rst b/docs/fastdds/api_reference/transport/tcp_transport_interface.rst index ecdfaf800..3a1fa808c 100644 --- a/docs/fastdds/api_reference/transport/tcp_transport_interface.rst +++ b/docs/fastdds/api_reference/transport/tcp_transport_interface.rst @@ -2,6 +2,7 @@ TCP Transport ============= .. toctree:: + :titlesonly: /fastdds/api_reference/transport/tcp_transport/tcp_transport_descriptor.rst /fastdds/api_reference/transport/tcp_transport/tcpv4_transport_descriptor.rst diff --git a/docs/fastdds/api_reference/transport/transport.rst b/docs/fastdds/api_reference/transport/transport.rst index d088cad83..650a00e8b 100644 --- a/docs/fastdds/api_reference/transport/transport.rst +++ b/docs/fastdds/api_reference/transport/transport.rst @@ -6,6 +6,7 @@ Transport *eProsima Fast DDS* Transport Layer API. .. toctree:: + :titlesonly: /fastdds/api_reference/transport/transport_generic_interfaces.rst /fastdds/api_reference/transport/chaining_transport.rst diff --git a/docs/fastdds/api_reference/transport/transport_generic_interfaces.rst b/docs/fastdds/api_reference/transport/transport_generic_interfaces.rst index 754d594de..bb0326113 100644 --- a/docs/fastdds/api_reference/transport/transport_generic_interfaces.rst +++ b/docs/fastdds/api_reference/transport/transport_generic_interfaces.rst @@ -2,6 +2,7 @@ Transport Generic Interfaces ============================ .. toctree:: + :titlesonly: /fastdds/api_reference/transport/transport_generic_interfaces/transport_descriptor_interface.rst /fastdds/api_reference/transport/transport_generic_interfaces/transport_interface.rst diff --git a/docs/fastdds/api_reference/transport/udp_transport/test_udpv4_transport_descriptor.rst b/docs/fastdds/api_reference/transport/udp_transport/test_udpv4_transport_descriptor.rst deleted file mode 100644 index 00cf08bc5..000000000 --- a/docs/fastdds/api_reference/transport/udp_transport/test_udpv4_transport_descriptor.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _api_test_udpv4_transport_descriptor: - -test_UDPv4TransportDescriptor ------------------------------ - -.. doxygenstruct:: eprosima::fastdds::rtps::test_UDPv4TransportDescriptor - :project: FastDDS - :members: diff --git a/docs/fastdds/api_reference/transport/udp_transport_interface.rst b/docs/fastdds/api_reference/transport/udp_transport_interface.rst index b16bf6539..b62724a50 100644 --- a/docs/fastdds/api_reference/transport/udp_transport_interface.rst +++ b/docs/fastdds/api_reference/transport/udp_transport_interface.rst @@ -2,8 +2,8 @@ UDP Transport ============= .. toctree:: + :titlesonly: /fastdds/api_reference/transport/udp_transport/udp_transport_descriptor.rst /fastdds/api_reference/transport/udp_transport/udpv4_transport_descriptor.rst /fastdds/api_reference/transport/udp_transport/udpv6_transport_descriptor.rst - /fastdds/api_reference/transport/udp_transport/test_udpv4_transport_descriptor.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/core/core.rst b/docs/fastdds/python_api_reference/dds_pim/core/core.rst index ec73bef5e..aeeae3b94 100644 --- a/docs/fastdds/python_api_reference/dds_pim/core/core.rst +++ b/docs/fastdds/python_api_reference/dds_pim/core/core.rst @@ -2,12 +2,13 @@ Core ==== .. toctree:: + :titlesonly: - /fastdds/python_api_reference/dds_pim/core/entity.rst - /fastdds/python_api_reference/dds_pim/core/domainentity.rst - /fastdds/python_api_reference/dds_pim/core/policy/policy.rst - /fastdds/python_api_reference/dds_pim/core/status/status.rst - /fastdds/python_api_reference/dds_pim/core/loanablearray.rst - /fastdds/python_api_reference/dds_pim/core/loanablecollection.rst - /fastdds/python_api_reference/dds_pim/core/loanablesequence.rst - /fastdds/python_api_reference/dds_pim/core/stackallocatedsequence.rst + /fastdds/python_api_reference/dds_pim/core/entity.rst + /fastdds/python_api_reference/dds_pim/core/domainentity.rst + /fastdds/python_api_reference/dds_pim/core/policy/policy.rst + /fastdds/python_api_reference/dds_pim/core/status/status.rst + /fastdds/python_api_reference/dds_pim/core/loanablearray.rst + /fastdds/python_api_reference/dds_pim/core/loanablecollection.rst + /fastdds/python_api_reference/dds_pim/core/loanablesequence.rst + /fastdds/python_api_reference/dds_pim/core/stackallocatedsequence.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/core/policy/policy.rst b/docs/fastdds/python_api_reference/dds_pim/core/policy/policy.rst index f5cc0b855..25dcdd1cb 100644 --- a/docs/fastdds/python_api_reference/dds_pim/core/policy/policy.rst +++ b/docs/fastdds/python_api_reference/dds_pim/core/policy/policy.rst @@ -2,52 +2,53 @@ Policy ====== .. toctree:: + :titlesonly: - /fastdds/python_api_reference/dds_pim/core/policy/datarepresentationid.rst - /fastdds/python_api_reference/dds_pim/core/policy/datarepresentationqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/datasharingqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/datasharingkind.rst - /fastdds/python_api_reference/dds_pim/core/policy/deadlineqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/destinationorderqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/destinationorderqospolicykind.rst - /fastdds/python_api_reference/dds_pim/core/policy/disablepositiveacksqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/durabilityqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/durabilityqospolicykind.rst - /fastdds/python_api_reference/dds_pim/core/policy/durabilityserviceqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/entityfactoryqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/genericdataqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/groupdataqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/historyqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/historyqospolicykind.rst - /fastdds/python_api_reference/dds_pim/core/policy/latencybudgetqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/lifespanqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/livelinessqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/livelinessqospolicykind.rst - /fastdds/python_api_reference/dds_pim/core/policy/ownershipqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/ownershipqospolicykind.rst - /fastdds/python_api_reference/dds_pim/core/policy/ownershipstrengthqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/participantresourcelimitsqos.rst - /fastdds/python_api_reference/dds_pim/core/policy/partition_t.rst - /fastdds/python_api_reference/dds_pim/core/policy/partitionqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/presentationqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/presentationqospolicyaccessscopekind.rst - /fastdds/python_api_reference/dds_pim/core/policy/propertypolicyqos.rst - /fastdds/python_api_reference/dds_pim/core/policy/publishmodeqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/publishmodeqospolicykind.rst - /fastdds/python_api_reference/dds_pim/core/policy/qospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/qospolicyid_t.rst - /fastdds/python_api_reference/dds_pim/core/policy/readerdatalifecycleqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/reliabilityqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/reliabilityqospolicykind.rst - /fastdds/python_api_reference/dds_pim/core/policy/resourcelimitsqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/rtpsendpointqos.rst - /fastdds/python_api_reference/dds_pim/core/policy/timebasedfilterqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/topicdataqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/transportconfigqos.rst - /fastdds/python_api_reference/dds_pim/core/policy/transportpriorityqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/typeconsistencyenforcementqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/typeconsistencykind.rst - /fastdds/python_api_reference/dds_pim/core/policy/userdataqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/wireprotocolconfigqos.rst - /fastdds/python_api_reference/dds_pim/core/policy/writerdatalifecycleqospolicy.rst - /fastdds/python_api_reference/dds_pim/core/policy/writerresourcelimitsqos.rst + /fastdds/python_api_reference/dds_pim/core/policy/datarepresentationid.rst + /fastdds/python_api_reference/dds_pim/core/policy/datarepresentationqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/datasharingqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/datasharingkind.rst + /fastdds/python_api_reference/dds_pim/core/policy/deadlineqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/destinationorderqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/destinationorderqospolicykind.rst + /fastdds/python_api_reference/dds_pim/core/policy/disablepositiveacksqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/durabilityqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/durabilityqospolicykind.rst + /fastdds/python_api_reference/dds_pim/core/policy/durabilityserviceqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/entityfactoryqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/genericdataqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/groupdataqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/historyqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/historyqospolicykind.rst + /fastdds/python_api_reference/dds_pim/core/policy/latencybudgetqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/lifespanqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/livelinessqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/livelinessqospolicykind.rst + /fastdds/python_api_reference/dds_pim/core/policy/ownershipqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/ownershipqospolicykind.rst + /fastdds/python_api_reference/dds_pim/core/policy/ownershipstrengthqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/participantresourcelimitsqos.rst + /fastdds/python_api_reference/dds_pim/core/policy/partition_t.rst + /fastdds/python_api_reference/dds_pim/core/policy/partitionqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/presentationqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/presentationqospolicyaccessscopekind.rst + /fastdds/python_api_reference/dds_pim/core/policy/propertypolicyqos.rst + /fastdds/python_api_reference/dds_pim/core/policy/publishmodeqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/publishmodeqospolicykind.rst + /fastdds/python_api_reference/dds_pim/core/policy/qospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/qospolicyid_t.rst + /fastdds/python_api_reference/dds_pim/core/policy/readerdatalifecycleqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/reliabilityqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/reliabilityqospolicykind.rst + /fastdds/python_api_reference/dds_pim/core/policy/resourcelimitsqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/rtpsendpointqos.rst + /fastdds/python_api_reference/dds_pim/core/policy/timebasedfilterqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/topicdataqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/transportconfigqos.rst + /fastdds/python_api_reference/dds_pim/core/policy/transportpriorityqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/typeconsistencyenforcementqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/typeconsistencykind.rst + /fastdds/python_api_reference/dds_pim/core/policy/userdataqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/wireprotocolconfigqos.rst + /fastdds/python_api_reference/dds_pim/core/policy/writerdatalifecycleqospolicy.rst + /fastdds/python_api_reference/dds_pim/core/policy/writerresourcelimitsqos.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/core/status/status.rst b/docs/fastdds/python_api_reference/dds_pim/core/status/status.rst index 30f3db2b1..ec05889e7 100644 --- a/docs/fastdds/python_api_reference/dds_pim/core/status/status.rst +++ b/docs/fastdds/python_api_reference/dds_pim/core/status/status.rst @@ -2,23 +2,24 @@ Status ====== .. toctree:: + :titlesonly: - /fastdds/python_api_reference/dds_pim/core/status/basestatus.rst - /fastdds/python_api_reference/dds_pim/core/status/deadlinemissedstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/incompatibleqosstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/inconsistenttopicstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/livelinesschangedstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/matchedstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/offereddeadlinemissedstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/offeredincompatibleqosstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/publicationmatchedstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/qospolicycount.rst - /fastdds/python_api_reference/dds_pim/core/status/qospolicycountseq.rst - /fastdds/python_api_reference/dds_pim/core/status/requesteddeadlinemissedstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/requestedincompatibleqosstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/rtpslivelinessloststatus.rst - /fastdds/python_api_reference/dds_pim/core/status/sampleloststatus.rst - /fastdds/python_api_reference/dds_pim/core/status/samplerejectedstatus.rst - /fastdds/python_api_reference/dds_pim/core/status/samplerejectedstatuskind.rst - /fastdds/python_api_reference/dds_pim/core/status/statusmask.rst - /fastdds/python_api_reference/dds_pim/core/status/subscriptionmatchedstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/basestatus.rst + /fastdds/python_api_reference/dds_pim/core/status/deadlinemissedstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/incompatibleqosstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/inconsistenttopicstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/livelinesschangedstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/matchedstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/offereddeadlinemissedstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/offeredincompatibleqosstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/publicationmatchedstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/qospolicycount.rst + /fastdds/python_api_reference/dds_pim/core/status/qospolicycountseq.rst + /fastdds/python_api_reference/dds_pim/core/status/requesteddeadlinemissedstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/requestedincompatibleqosstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/rtpslivelinessloststatus.rst + /fastdds/python_api_reference/dds_pim/core/status/sampleloststatus.rst + /fastdds/python_api_reference/dds_pim/core/status/samplerejectedstatus.rst + /fastdds/python_api_reference/dds_pim/core/status/samplerejectedstatuskind.rst + /fastdds/python_api_reference/dds_pim/core/status/statusmask.rst + /fastdds/python_api_reference/dds_pim/core/status/subscriptionmatchedstatus.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/dds_pim.rst b/docs/fastdds/python_api_reference/dds_pim/dds_pim.rst index 7f61af460..305a339f0 100644 --- a/docs/fastdds/python_api_reference/dds_pim/dds_pim.rst +++ b/docs/fastdds/python_api_reference/dds_pim/dds_pim.rst @@ -6,9 +6,10 @@ DDS DCPS PIM Data Distribution Service (DDS) Data-Centric Publish-Subscribe (DCPS) Platform Independent Model (PIM) API .. toctree:: + :titlesonly: - /fastdds/python_api_reference/dds_pim/core/core.rst - /fastdds/python_api_reference/dds_pim/domain/domain.rst - /fastdds/python_api_reference/dds_pim/publisher/publisher.rst - /fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst - /fastdds/python_api_reference/dds_pim/topic/topic.rst + /fastdds/python_api_reference/dds_pim/core/core.rst + /fastdds/python_api_reference/dds_pim/domain/domain.rst + /fastdds/python_api_reference/dds_pim/publisher/publisher.rst + /fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst + /fastdds/python_api_reference/dds_pim/topic/topic.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/domain/domain.rst b/docs/fastdds/python_api_reference/dds_pim/domain/domain.rst index 0537a9f8d..a3ba99f6d 100644 --- a/docs/fastdds/python_api_reference/dds_pim/domain/domain.rst +++ b/docs/fastdds/python_api_reference/dds_pim/domain/domain.rst @@ -2,9 +2,10 @@ Domain ====== .. toctree:: + :titlesonly: - /fastdds/python_api_reference/dds_pim/domain/domainparticipant.rst - /fastdds/python_api_reference/dds_pim/domain/domainparticipantfactory.rst - /fastdds/python_api_reference/dds_pim/domain/domainparticipantfactoryqos.rst - /fastdds/python_api_reference/dds_pim/domain/domainparticipantlistener.rst - /fastdds/python_api_reference/dds_pim/domain/domainparticipantqos.rst + /fastdds/python_api_reference/dds_pim/domain/domainparticipant.rst + /fastdds/python_api_reference/dds_pim/domain/domainparticipantfactory.rst + /fastdds/python_api_reference/dds_pim/domain/domainparticipantfactoryqos.rst + /fastdds/python_api_reference/dds_pim/domain/domainparticipantlistener.rst + /fastdds/python_api_reference/dds_pim/domain/domainparticipantqos.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/domain/domainparticipantqos.rst b/docs/fastdds/python_api_reference/dds_pim/domain/domainparticipantqos.rst index 8c3cef901..92811b856 100644 --- a/docs/fastdds/python_api_reference/dds_pim/domain/domainparticipantqos.rst +++ b/docs/fastdds/python_api_reference/dds_pim/domain/domainparticipantqos.rst @@ -8,5 +8,5 @@ DomainParticipantQos .. autoclass:: fastdds.DomainParticipantQos -.. TODO - .. autoclass:: fastdds.PARTICIPANT_QOS_DEFAULT +.. autodata:: fastdds.PARTICIPANT_QOS_DEFAULT + :annotation: = diff --git a/docs/fastdds/python_api_reference/dds_pim/publisher/datawriterqos.rst b/docs/fastdds/python_api_reference/dds_pim/publisher/datawriterqos.rst index afbc3195f..33c358870 100644 --- a/docs/fastdds/python_api_reference/dds_pim/publisher/datawriterqos.rst +++ b/docs/fastdds/python_api_reference/dds_pim/publisher/datawriterqos.rst @@ -7,6 +7,8 @@ DataWriterQos .. autoclass:: fastdds.DataWriterQos -.. autoclass:: fastdds.DATAWRITER_QOS_DEFAULT +.. autodata:: fastdds.DATAWRITER_QOS_DEFAULT + :annotation: = -.. autoclass:: fastdds.DATAWRITER_QOS_USE_TOPIC_QOS +.. autodata:: fastdds.DATAWRITER_QOS_USE_TOPIC_QOS + :annotation: = diff --git a/docs/fastdds/python_api_reference/dds_pim/publisher/publisher.rst b/docs/fastdds/python_api_reference/dds_pim/publisher/publisher.rst index 5bf5a5566..561c83ce9 100644 --- a/docs/fastdds/python_api_reference/dds_pim/publisher/publisher.rst +++ b/docs/fastdds/python_api_reference/dds_pim/publisher/publisher.rst @@ -2,11 +2,12 @@ Publisher ========= .. toctree:: + :titlesonly: - /fastdds/python_api_reference/dds_pim/publisher/datawriter.rst - /fastdds/python_api_reference/dds_pim/publisher/datawriterlistener.rst - /fastdds/python_api_reference/dds_pim/publisher/datawriterqos.rst - /fastdds/python_api_reference/dds_pim/publisher/publisher_class.rst - /fastdds/python_api_reference/dds_pim/publisher/publisherlistener.rst - /fastdds/python_api_reference/dds_pim/publisher/publisherqos.rst - /fastdds/python_api_reference/dds_pim/publisher/rtpsreliablewriterqos.rst + /fastdds/python_api_reference/dds_pim/publisher/datawriter.rst + /fastdds/python_api_reference/dds_pim/publisher/datawriterlistener.rst + /fastdds/python_api_reference/dds_pim/publisher/datawriterqos.rst + /fastdds/python_api_reference/dds_pim/publisher/publisher_class.rst + /fastdds/python_api_reference/dds_pim/publisher/publisherlistener.rst + /fastdds/python_api_reference/dds_pim/publisher/publisherqos.rst + /fastdds/python_api_reference/dds_pim/publisher/rtpsreliablewriterqos.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/publisher/publisherqos.rst b/docs/fastdds/python_api_reference/dds_pim/publisher/publisherqos.rst index 71073d4c6..206fe65eb 100644 --- a/docs/fastdds/python_api_reference/dds_pim/publisher/publisherqos.rst +++ b/docs/fastdds/python_api_reference/dds_pim/publisher/publisherqos.rst @@ -7,4 +7,5 @@ PublisherQos .. autoclass:: fastdds.PublisherQos -.. autoclass:: fastdds.PUBLISHER_QOS_DEFAULT +.. autodata:: fastdds.PUBLISHER_QOS_DEFAULT + :annotation: = diff --git a/docs/fastdds/python_api_reference/dds_pim/subscriber/datareaderqos.rst b/docs/fastdds/python_api_reference/dds_pim/subscriber/datareaderqos.rst index 5d50a7abc..d3ac655ae 100644 --- a/docs/fastdds/python_api_reference/dds_pim/subscriber/datareaderqos.rst +++ b/docs/fastdds/python_api_reference/dds_pim/subscriber/datareaderqos.rst @@ -7,6 +7,8 @@ DataReaderQos .. autoclass:: fastdds.DataReaderQos -.. autoclass:: fastdds.DATAREADER_QOS_DEFAULT +.. autodata:: fastdds.DATAREADER_QOS_DEFAULT + :annotation: = -.. autoclass:: fastdds.DATAREADER_QOS_USE_TOPIC_QOS +.. autodata:: fastdds.DATAREADER_QOS_USE_TOPIC_QOS + :annotation: = diff --git a/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst b/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst index 8e8645f16..f04c1d429 100644 --- a/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst +++ b/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriber.rst @@ -2,17 +2,18 @@ Subscriber ========== .. toctree:: + :titlesonly: - /fastdds/python_api_reference/dds_pim/subscriber/datareader.rst - /fastdds/python_api_reference/dds_pim/subscriber/datareaderlistener.rst - /fastdds/python_api_reference/dds_pim/subscriber/datareaderqos.rst - /fastdds/python_api_reference/dds_pim/subscriber/instancestatekind.rst - /fastdds/python_api_reference/dds_pim/subscriber/readerresourcelimitsqos.rst - /fastdds/python_api_reference/dds_pim/subscriber/rtpsreliablereaderqos.rst - /fastdds/python_api_reference/dds_pim/subscriber/sampleinfo.rst - /fastdds/python_api_reference/dds_pim/subscriber/samplestatekind.rst - /fastdds/python_api_reference/dds_pim/subscriber/subscriber_class.rst - /fastdds/python_api_reference/dds_pim/subscriber/subscriberlistener.rst - /fastdds/python_api_reference/dds_pim/subscriber/subscriberqos.rst - /fastdds/python_api_reference/dds_pim/subscriber/typeconsistencyqos.rst - /fastdds/python_api_reference/dds_pim/subscriber/viewstatekind.rst + /fastdds/python_api_reference/dds_pim/subscriber/datareader.rst + /fastdds/python_api_reference/dds_pim/subscriber/datareaderlistener.rst + /fastdds/python_api_reference/dds_pim/subscriber/datareaderqos.rst + /fastdds/python_api_reference/dds_pim/subscriber/instancestatekind.rst + /fastdds/python_api_reference/dds_pim/subscriber/readerresourcelimitsqos.rst + /fastdds/python_api_reference/dds_pim/subscriber/rtpsreliablereaderqos.rst + /fastdds/python_api_reference/dds_pim/subscriber/sampleinfo.rst + /fastdds/python_api_reference/dds_pim/subscriber/samplestatekind.rst + /fastdds/python_api_reference/dds_pim/subscriber/subscriber_class.rst + /fastdds/python_api_reference/dds_pim/subscriber/subscriberlistener.rst + /fastdds/python_api_reference/dds_pim/subscriber/subscriberqos.rst + /fastdds/python_api_reference/dds_pim/subscriber/typeconsistencyqos.rst + /fastdds/python_api_reference/dds_pim/subscriber/viewstatekind.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriberqos.rst b/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriberqos.rst index 48ea76696..f0646cfba 100644 --- a/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriberqos.rst +++ b/docs/fastdds/python_api_reference/dds_pim/subscriber/subscriberqos.rst @@ -7,4 +7,5 @@ SubscriberQos .. autoclass:: fastdds.SubscriberQos -.. autoclass:: fastdds.SUBSCRIBER_QOS_DEFAULT +.. autodata:: fastdds.SUBSCRIBER_QOS_DEFAULT + :annotation: = diff --git a/docs/fastdds/python_api_reference/dds_pim/topic/topic.rst b/docs/fastdds/python_api_reference/dds_pim/topic/topic.rst index c95cab522..e8400c315 100644 --- a/docs/fastdds/python_api_reference/dds_pim/topic/topic.rst +++ b/docs/fastdds/python_api_reference/dds_pim/topic/topic.rst @@ -2,13 +2,14 @@ Topic ===== .. toctree:: + :titlesonly: - /fastdds/python_api_reference/dds_pim/topic/topic_class.rst - /fastdds/python_api_reference/dds_pim/topic/topicdatatype.rst - /fastdds/python_api_reference/dds_pim/topic/topicdescription.rst - /fastdds/python_api_reference/dds_pim/topic/topiclistener.rst - /fastdds/python_api_reference/dds_pim/topic/topicqos.rst - /fastdds/python_api_reference/dds_pim/topic/typeidv1.rst - /fastdds/python_api_reference/dds_pim/topic/typeinformation.rst - /fastdds/python_api_reference/dds_pim/topic/typeobjectv1.rst - /fastdds/python_api_reference/dds_pim/topic/typesupport.rst + /fastdds/python_api_reference/dds_pim/topic/topic_class.rst + /fastdds/python_api_reference/dds_pim/topic/topicdatatype.rst + /fastdds/python_api_reference/dds_pim/topic/topicdescription.rst + /fastdds/python_api_reference/dds_pim/topic/topiclistener.rst + /fastdds/python_api_reference/dds_pim/topic/topicqos.rst + /fastdds/python_api_reference/dds_pim/topic/typeidv1.rst + /fastdds/python_api_reference/dds_pim/topic/typeinformation.rst + /fastdds/python_api_reference/dds_pim/topic/typeobjectv1.rst + /fastdds/python_api_reference/dds_pim/topic/typesupport.rst diff --git a/docs/fastdds/python_api_reference/dds_pim/topic/topicqos.rst b/docs/fastdds/python_api_reference/dds_pim/topic/topicqos.rst index db6dfe0c0..91774105c 100644 --- a/docs/fastdds/python_api_reference/dds_pim/topic/topicqos.rst +++ b/docs/fastdds/python_api_reference/dds_pim/topic/topicqos.rst @@ -7,4 +7,5 @@ TopicQos .. autoclass:: fastdds.TopicQos -.. autoclass:: fastdds.TOPIC_QOS_DEFAULT +.. autodata:: fastdds.TOPIC_QOS_DEFAULT + :annotation: = diff --git a/docs/fastdds/python_api_reference/python_api_reference.rst b/docs/fastdds/python_api_reference/python_api_reference.rst index b177b6271..115880c3c 100644 --- a/docs/fastdds/python_api_reference/python_api_reference.rst +++ b/docs/fastdds/python_api_reference/python_api_reference.rst @@ -6,5 +6,6 @@ Python API Reference This section presents the most commonly used Python APIs provided by *Fast DDS*. .. toctree:: + :titlesonly: - /fastdds/python_api_reference/dds_pim/dds_pim + /fastdds/python_api_reference/dds_pim/dds_pim diff --git a/docs/fastdds/xtypes/language_binding.rst b/docs/fastdds/xtypes/language_binding.rst index 2ea446579..ca31225c8 100644 --- a/docs/fastdds/xtypes/language_binding.rst +++ b/docs/fastdds/xtypes/language_binding.rst @@ -766,7 +766,7 @@ For a detailed explanation about the XML definition of this type, please refer t .. _xtypes_supportedtypes_bitset: Bitset Types -"""""""""""" +^^^^^^^^^^^^ Bitset types are an aggregation of bitfields. The :code:`TypeKind` used to identify bitsets is :code:`TK_BITSET`. @@ -921,7 +921,8 @@ Please, refer to :ref:`builtin annotations ` for the comple - ✅ - ❌ * - :code:`@bit_bound` - - |TypeDescriptor-api| :code:`bound` property. + - |TypeDescriptor-api| :code:`bound` property for :ref:`xtypes_supportedtypes_bitset`. |br| + |MemberDescriptor-api| :code:`type` property for :ref:`xtypes_supportedtypes_enumeration`. - ✅ - ✅❌ (`Enumeration types`_ not configurable). * - :code:`@default` @@ -981,11 +982,6 @@ Please, refer to :ref:`builtin annotations ` for the comple - ❌ - ❌ -To apply the :code:`@extensibility` annotation (and its shortcuts) the |TypeDescriptor-api| provides -:code:`extensibility_kind` property. - -:code:`@key` annotation is applied enabling |MemberDescriptor-api| :code:`is_key` property. - .. _xtypes_complextypes: Managing Complex Types Data diff --git a/docs/fastdds/xtypes/xtypes.rst b/docs/fastdds/xtypes/xtypes.rst index da79d8c53..b9b48b652 100644 --- a/docs/fastdds/xtypes/xtypes.rst +++ b/docs/fastdds/xtypes/xtypes.rst @@ -9,11 +9,6 @@ XTypes This specification defines the following concepts: * DDS supported type system, including the concept of extensible types that might evolve in time. - -.. note:: - - This section also defines the type compatibility rules among evolved types which is still unsupported in Fast DDS. - * Type representation, including :ref:`IDL` and :ref:`TypeObject` representations. * Data representation over the wire. @@ -28,3 +23,7 @@ This specification defines the following concepts: /fastdds/xtypes/discovery_matching.rst /fastdds/xtypes/language_binding.rst + +.. note:: + + Type compatibility rules among evolved types are still unsupported in Fast DDS. diff --git a/docs/requirements.txt b/docs/requirements.txt index e5d438779..750b4b946 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,19 +2,20 @@ breathe==4.35.0 colcon-common-extensions==0.2.1 colcon-mixin==0.2.0 doc8==0.10.1 -docutils==0.16.0 +docutils==0.20.1 GitPython==3.1.41 setuptools==67.6.0 -sphinx_rtd_theme==0.5.2 -sphinx-tabs==3.2.0 -sphinx==4.3.1 -sphinxcontrib-applehelp==1.0.4 -sphinxcontrib-devhelp==1.0.2 -sphinxcontrib-htmlhelp==2.0.1 +sphinx_rtd_theme==2.0.0 +sphinx-tabs==3.4.5 +# TODO(anyone) remove if https://github.com/sphinx-doc/sphinx/pull/12298/files is merged +sphinx==7.2.6 +sphinxcontrib-applehelp==1.0.8 +sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-htmlhelp==2.0.5 sphinxcontrib-imagehelper==1.1.1 -sphinxcontrib-plantuml==0.22 -sphinxcontrib-qthelp==1.0.3 -sphinxcontrib-serializinghtml==1.1.5 -sphinxcontrib.spelling==7.2.1 +sphinxcontrib-plantuml==0.29 +sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-serializinghtml==1.1.10 +sphinxcontrib.spelling==8.0.0 vcstool==0.3.0 xmlschema==2.1.1