Skip to content

Commit

Permalink
Refs #20631. Update requirements and fix warnings
Browse files Browse the repository at this point in the history
Signed-off-by: Ricardo González Moreno <ricardo@richiware.dev>
  • Loading branch information
richiware committed Apr 18, 2024
1 parent d74e219 commit 06c0026
Show file tree
Hide file tree
Showing 68 changed files with 204 additions and 150 deletions.
11 changes: 6 additions & 5 deletions docs/fastdds/api_reference/api_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/dds_pim/core/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Core
====

.. toctree::
:titlesonly:

/fastdds/api_reference/dds_pim/core/entity.rst
/fastdds/api_reference/dds_pim/core/domainentity.rst
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/dds_pim/core/policy/policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/dds_pim/core/status/status.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/dds_pim/dds_pim.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/dds_pim/domain/domain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Domain
======

.. toctree::
:titlesonly:

/fastdds/api_reference/dds_pim/domain/domainparticipant.rst
/fastdds/api_reference/dds_pim/domain/domainparticipantfactory.rst
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/dds_pim/publisher/publisher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Publisher
=========

.. toctree::
:titlesonly:

/fastdds/api_reference/dds_pim/publisher/datawriter.rst
/fastdds/api_reference/dds_pim/publisher/datawriterlistener.rst
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Subscriber
==========

.. toctree::
:titlesonly:

/fastdds/api_reference/dds_pim/subscriber/datareader.rst
/fastdds/api_reference/dds_pim/subscriber/datareaderlistener.rst
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/dds_pim/topic/topic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Topic
=====

.. toctree::
:titlesonly:

/fastdds/api_reference/dds_pim/topic/topicdatatype.rst
/fastdds/api_reference/dds_pim/topic/typesupport.rst
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Type Representation
===================

.. toctree::
:titlesonly:

/fastdds/api_reference/dds_pim/xtypes/typeobjectregistry.rst
/fastdds/api_reference/dds_pim/xtypes/typeobjectutils.rst
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/dds_pim/xtypes/xtypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ XTypes
======

.. toctree::
:titlesonly:

/fastdds/api_reference/dds_pim/xtypes/dynamic_types.rst
/fastdds/api_reference/dds_pim/xtypes/exception.rst
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/log/colors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ Colors
A collection of macros for ease the stream coloring.

.. toctree::
:titlesonly:

/fastdds/api_reference/log/colors/colors.rst
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/log/log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/attributes/attributes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Attributes
============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/attributes/BuiltinAttributes
/fastdds/api_reference/rtps/attributes/c_default_RTPSParticipantAllocationAttributes
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/builtin/data/data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ Builtin data
============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/builtin/data/ContentFilterProperty
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ BinaryProperty
===============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/BinaryProperty/BinaryProperty
/fastdds/api_reference/rtps/common/BinaryProperty/BinaryPropertyHelper
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ CDRMessage
===============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/CDRMessage_t/CDRMessage_t
/fastdds/api_reference/rtps/common/CDRMessage_t/defines
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ CacheChange
===============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/CacheChange/CacheChange_t
/fastdds/api_reference/rtps/common/CacheChange/ChangeForReader_t
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ FragmentNumber
===============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/FragmentNumber/FragmentNumber_t
/fastdds/api_reference/rtps/common/FragmentNumber/FragmentNumberSet_t
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/common/Guid/guid_toc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Guid
===============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/Guid/c_Guid_Unknown
/fastdds/api_reference/rtps/common/Guid/GUID_t
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ InstanceHandle
===============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/InstanceHandle/c_InstanceHandle_Unknown
/fastdds/api_reference/rtps/common/InstanceHandle/InstanceHandle_t
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Locator
===============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/Locator/defines
/fastdds/api_reference/rtps/common/Locator/IsAddressDefined
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ MatchingInfo
------------

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/MatchingInfo/MatchingInfo
/fastdds/api_reference/rtps/common/MatchingInfo/MatchingStatus
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Property
===============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/Property/Property
/fastdds/api_reference/rtps/common/Property/PropertyHelper
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ RemoteLocators
===============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/RemoteLocators/operators
/fastdds/api_reference/rtps/common/RemoteLocators/RemoteLocatorList
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ SequenceNumber
---------------

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/SequenceNumber/c_SequenceNumber_Unknown
/fastdds/api_reference/rtps/common/SequenceNumber/operators
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ SerializedPayload
-------------------

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/SerializedPayload/defines
/fastdds/api_reference/rtps/common/SerializedPayload/SerializedPayload_t
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/common/Time_t/time_toc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/common/Token/token_toc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Token
--------------------

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/Token/AuthenticatedPeerCredentialToken
/fastdds/api_reference/rtps/common/Token/DataHolder
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/common/Types/types_toc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Types
--------------------

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/Types/BuiltinEndpointSet_t
/fastdds/api_reference/rtps/common/Types/const_values
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/common/common.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Common
======

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/common/BinaryProperty/binaryproperty_toc
/fastdds/api_reference/rtps/common/CacheChange/cachechange_toc
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/exceptions/exceptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ Exceptions
============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/exceptions/Exception
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Flow control
============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/flowcontrol/FlowControllerDescriptor
/fastdds/api_reference/rtps/flowcontrol/FlowControllerSchedulerPolicy
3 changes: 1 addition & 2 deletions docs/fastdds/api_reference/rtps/history/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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


Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ RTPSParticipant
=================

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/participant/participantdiscoveryinfo/participantdiscoveryinfo
/fastdds/api_reference/rtps/participant/RTPSParticipant
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ ParticipantDiscoveryInfo
============================

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/participant/participantdiscoveryinfo/ParticipantAuthenticationInfo
/fastdds/api_reference/rtps/participant/participantdiscoveryinfo/ParticipantDiscoveryInfo_class
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/reader/reader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ RTPSReader
============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/reader/ReaderListener
/fastdds/api_reference/rtps/reader/RTPSReader
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/resources/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ Resources
============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/resources/MemoryManagementPolicy
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/rtps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ RTPS
*eProsima Fast DDS* Real-Time Publish-Subscribe (RTPS) layer API.

.. toctree::
:titlesonly:


/fastdds/api_reference/rtps/attributes/attributes
Expand Down
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/rtps/writer/writer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ RTPSWriter
============

.. toctree::
:titlesonly:

/fastdds/api_reference/rtps/writer/RTPSWriter.rst
/fastdds/api_reference/rtps/writer/WriterListener.rst
1 change: 1 addition & 0 deletions docs/fastdds/api_reference/statistics/statistics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ Shared Memory Transport
=======================

.. toctree::
:titlesonly:

/fastdds/api_reference/transport/shm_transport/shared_mem_transport_descriptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit 06c0026

Please sign in to comment.