Fix multiple references warnings using v0x04

This commit will fix sphinx warnings with more than one target found

Author: macartur

pyof/v0x04/asynchronous/flow_removed.py

@@ -37,7 +37,7 @@ class FlowRemoved(GenericMessage):
     OFPT_FLOW_REMOVED message.
     """
 
-    #: :class:`~.header.Header`: OpenFlow Header
+    #: :class:`~pyof.v0x04.common.header.Header`: OpenFlow Header
     header = Header(message_type=Type.OFPT_FLOW_REMOVED)
     #: Opaque controller-issued identifier.
     cookie = UBInt64()
@@ -58,7 +58,7 @@ class FlowRemoved(GenericMessage):
     packet_count = UBInt64()
     byte_count = UBInt64()
     #: Description of fields. Variable size.
-    #: :class:`~.common.flow_match.Match`
+    #: :class:`~pyof.v0x04.common.flow_match.Match`
     match = Match()
 
     def __init__(self, xid=None, cookie=None, priority=None, reason=None,
@@ -71,7 +71,8 @@ def __init__(self, xid=None, cookie=None, priority=None, reason=None,
             xid (int): OpenFlow Header's xid.
             cookie (int): Opaque controller-issued identifier.
             priority (int): Priority level of flow entry.
-            reason (FlowRemovedReason): Why the flow was removed.
+            reason (~pyof.v0x04.asynchronous.flow_removed.FlowRemovedReason):
+                Why the flow was removed.
             table_id (int): ID of the table.
             duration_sec (int): Time the flow was alive in seconds.
             duration_nsec (int): Time the flow was alive in nanoseconds in
@@ -80,7 +81,7 @@ def __init__(self, xid=None, cookie=None, priority=None, reason=None,
             hard_timeout (int): Hard timeout from original flow mod.
             packet_count (int): Number of packets.
             byte_count (int): Byte count.
-            match (Match): Fields' description.
+            match (~pyof.v0x04.common.flow_match.Match): Fields' description.
         """
         super().__init__(xid)
         self.cookie = cookie

pyof/v0x04/asynchronous/packet_in.py

@@ -34,7 +34,7 @@ class PacketInReason(IntEnum):
 class PacketIn(GenericMessage):
     """Packet received on port (datapath -> controller)."""
 
-    #: :class:`~.header.Header`: OpenFlow Header
+    #: :class:`~pyof.v0x04.common.header.Header`: OpenFlow Header
     header = Header(message_type=Type.OFPT_PACKET_IN)
     #: ID assigned by datapath.
     buffer_id = UBInt32()
@@ -63,11 +63,12 @@ def __init__(self, xid=None, buffer_id=None, total_len=None, reason=None,
             xid (int): Header's xid.
             buffer_id (int): ID assigned by datapath.
             total_len (int): Full length of frame.
-            reason (PacketInReason): The reason why the packet is being sent
+            reason (~pyof.v0x04.asynchronous.packet_in.PacketInReason):
+                The reason why the packet is being sent
             table_id (int): ID of the table that was looked up
             cookie (int): Cookie of the flow entry that was looked up
-            match (:class:`~.common.flow_match.Match`): Packet metadata.
-                Variable size.
+            match (:class:`~pyof.v0x04.common.flow_match.Match`):
+                Packet metadata with variable size.
             data (bytes): Ethernet frame, halfway through 32-bit word, so the
                 IP header is 32-bit aligned. The amount of data is inferred
                 from the length field in the header. Because of padding,

pyof/v0x04/asynchronous/port_status.py

@@ -31,22 +31,23 @@ class PortReason(IntEnum):
 class PortStatus(GenericMessage):
     """A physical port has changed in the datapath."""
 
-    #: :class:`~.header.Header`: OpenFlow Header
+    #: :class:`~pyof.v0x04.common.action.ActionHeader`: OpenFlow Header
     header = Header(message_type=Type.OFPT_PORT_STATUS)
     #: One of OFPPR_*.
     reason = UBInt8(enum_ref=PortReason)
     #: Align to 32-bits.
     pad = Pad(7)
-    #: :class:`~.common.port.Port`
+    #: :class:`~pyof.v0x04.common.port.Port`
     desc = Port()
 
     def __init__(self, xid=None, reason=None, desc=None):
         """Assign parameters to object attributes.
 
         Args:
             xid (int): Header's xid.
-            reason (:class:`~PortReason`): Addition, deletion or modification.
-            desc (Port): Port description.
+            reason (~pyof.v0x04.asynchronous.port_status.PortReason):
+                Addition, deletion or modification.
+            desc (~pyof.v0x04.common.port.Port): Port description.
         """
         super().__init__(xid)
         self.reason = reason

pyof/v0x04/common/action.py

@@ -138,7 +138,8 @@ def __init__(self, action_type=None, length=None):
         """The following constructor parameters are optional.
 
         Args:
-            action_type (ActionType): The type of the action.
+            action_type (~pyof.v0x04.common.action.ActionType):
+                The type of the action.
             length (int): Length of action, including this header.
         """
         super().__init__()
@@ -335,6 +336,7 @@ def __init__(self, items=None):
         """The constructor just assings parameters to object attributes.
 
         Args:
-            items (ActionHeader): Instance or a list of instances.
+            items (~pyof.v0x04.common.action.ActionHeader):
+                Instance or a list of instances.
         """
         super().__init__(pyof_class=ActionHeader, items=items)

pyof/v0x04/common/flow_instructions.py

@@ -18,7 +18,8 @@
 
 __all__ = ('InstructionApplyAction', 'InstructionClearAction',
            'InstructionGotoTable', 'InstructionMeter', 'InstructionType',
-           'InstructionWriteAction', 'InstructionWriteMetadata')
+           'InstructionWriteAction', 'InstructionWriteMetadata',
+           'ListOfInstruction')
 
 # Enums
 

pyof/v0x04/common/header.py

@@ -94,7 +94,8 @@ def __init__(self, message_type=None, length=None, xid=randint(0, MAXID)):
         """The constructor takes the optional parameters below.
 
         Args:
-            message_type (Type): One of the OFPT_* constants.
+            message_type (~pyof.v0x04.common.header.Type):
+                One of the OFPT_* constants.
             length (int): Length including this ofp_header.
             xid (int): Transaction id associated with this packet. Replies use
                 the same id as was in the request to facilitate pairing.

pyof/v0x04/common/port.py

@@ -50,8 +50,10 @@ class PortNo(IntEnum):
 class PortConfig(GenericBitMask):
     """Flags to indicate behavior of the physical port.
 
-    These flags are used in :class:`~Port` to describe the current
-    configuration. They are used in the :class:`~PortMod` message to configure
+    These flags are used in :class:`Port` to describe the current
+    configuration. They are used in the
+    :class:`~pyof.v0x04.controller2switch.port_mod.PortMod`
+    message to configure
     the port's behavior.
 
     The :attr:`OFPPC_PORT_DOWN` bit indicates that the port has been
@@ -206,12 +208,16 @@ def __init__(self, port_no=None, hw_addr=None, name=None, config=None,
             port_no (int): Port number.
             hw_addr (HWAddress): Hardware address.
             name (str): Null-terminated name.
-            config (PortConfig): Bitmap of OFPPC* flags.
-            state (PortState): Bitmap of OFPPS* flags.
-            curr (PortFeatures): Current features.
-            advertised (PortFeatures): Features being advertised by the port.
-            supported (PortFeatures): Features supported by the port.
-            peer (PortFeatures): Features advertised by peer.
+            config (~pyof.v0x04.common.port.PortConfig):
+                Bitmap of OFPPC* flags.
+            state (~pyof.v0x04.common.port.PortState): Bitmap of OFPPS* flags.
+            curr (~pyof.v0x04.common.port.PortFeatures): Current features.
+            advertised (~pyof.v0x04.common.port.PortFeatures):
+                Features being advertised by the port.
+            supported (~pyof.v0x04.common.port.PortFeatures):
+                Features supported by the port.
+            peer (~pyof.v0x04.common.port.PortFeatures):
+                Features advertised by peer.
             curr_speed (int): Current port bitrate in kbps.
             max_speed (int): Max port bitrate in kbps.
         """
@@ -233,15 +239,17 @@ class ListOfPorts(FixedTypeList):
     """List of Ports.
 
     Represented by instances of :class:`Port` and used on
-    :class:`.FeaturesReply`/:class:`.SwitchFeatures` objects.
+    :class:`~pyof.v0x04.controller2switch.features_reply.FeaturesReply`/
+    :class:`~pyof.v0x04.controller2switch.features_reply.SwitchFeatures`
+    objects.
     """
 
     def __init__(self, items=None):
         """The constructor takes the optional parameter below.
 
         Args:
-            items (:class:`list`, :class:`Port`): One :class:`Port`
-                instance or list.
+            items (:class:`list`, :class:`~pyof.v0x04.common.port.Port`):
+                One :class:`~pyof.v0x04.common.port.Port` instance or list.
         """
         super().__init__(pyof_class=Port,
                          items=items)

pyof/v0x04/common/queue.py

@@ -46,7 +46,8 @@ def __init__(self, queue_property=None, length=None):
         """The contructor takes the paremeters below.
 
         Args:
-            queue_property (QueueProperties): The queue property.
+            queue_property (~pyof.v0x04.common.queue.QueueProperties):
+                The queue property.
             length (int): Length of property, including this header.
         """
         super().__init__()
@@ -93,8 +94,8 @@ def __init__(self, queue_id=None, port=None, length=None, properties=None):
             queue_id (int): ID of the specific queue.
             port (int): Port his queue is attached to.
             length (int): Length in bytes of this queue desc.
-            properties(ListOfProperties): Queue's list of properties. Default
-                is an empty list.
+            properties(~pyof.v0x04.common.queue.ListOfProperties):
+                Queue's list of properties. Default is an empty list.
         """
         super().__init__()
         self.queue_id = queue_id

pyof/v0x04/common/table_feature.py

@@ -89,7 +89,8 @@ def __init__(self, property_type=None):
         """Constructor of Generic Instruction receives the parameters bellow.
 
         Args:
-            type(TableFeaturePropType): Property Type value of this instance.
+            type(~pyof.v0x04.controller2switch.common.TableFeaturePropType):
+                Property Type value of this instance.
         """
         super().__init__()
         self.property_type = property_type
@@ -144,7 +145,8 @@ def __init__(self, property_type=TableFeaturePropType.OFPTFPT_INSTRUCTIONS,
         """Constructor of InstructionProperty receives the parameters bellow.
 
         Args:
-            type(TableFeaturePropType): Property Type value of this instance.
+            type(~pyof.v0x04.controller2switch.common.TableFeaturePropType):
+                Property Type value of this instance.
             instruction_ids(ListOfInstruction): List of Instruction instances.
         """
         super().__init__(property_type=property_type)
@@ -167,7 +169,8 @@ def __init__(self, property_type=TableFeaturePropType.OFPTFPT_NEXT_TABLES,
         """Constructor of NextTablesProperty receives the parameters bellow.
 
         Args:
-            type(TableFeaturePropType): Property Type value of this instance.
+            type(~pyof.v0x04.controller2switch.common.TableFeaturePropType):
+                Property Type value of this instance.
             next_table_ids(ListOfInstruction): List of InstructionGotoTable
                                                instances.
         """
@@ -194,7 +197,8 @@ def __init__(self,
         """Constructor of ActionsProperty receives the parameters bellow.
 
         Args:
-            type(TableFeaturePropType): Property Type value of this instance.
+            type(~pyof.v0x04.controller2switch.common.TableFeaturePr):
+                Property Type value of this instance.
             action_ids(ListOfActions): List of Action instances.
         """
         super().__init__(property_type)
@@ -221,8 +225,10 @@ def __init__(self, property_type=TableFeaturePropType.OFPTFPT_MATCH,
         """Constructor of OxmProperty receives the parameters bellow.
 
         Args:
-            type(TableFeaturePropType): Property Type value of this instance.
-            oxm_ids(ListOfOxmHeader): List of OxmHeader instances.
+            type(~pyof.v0x04.controller2switch.common.TableFeaturePropType):
+                Property Type value of this instance.
+            oxm_ids(~pyof.v0x04.common.flow_match.ListOfOxmHeader):
+                List of OxmHeader instances.
         """
         super().__init__(property_type)
         self.oxm_ids = oxm_ids
@@ -239,7 +245,8 @@ def __init__(self, items=None):
         """The constructor just assings parameters to object attributes.
 
         Args:
-            items (Property): Instance or a list of instances.
+            items (~pyof.v0x04.controller2switch.common.Property):
+                Instance or a list of instances.
         """
         super().__init__(pyof_class=Property, items=items)
 
@@ -293,7 +300,8 @@ def __init__(self, table_id=Table.OFPTT_ALL, name="",
             config(int):         Field reseved for future use.
             max_entries(int):    Describe the maximum number of flow entries
                                  that can be inserted into that table.
-            properties(ListOfProperty): List of Property intances.
+            properties(~pyof.v0x04.controller2switch.common.Property):
+                                 List of Property intances.
         """
         super().__init__()
         self.table_id = table_id

pyof/v0x04/common/utils.py

@@ -134,7 +134,7 @@ def new_message_from_header(header):
     """Given an OF Header, return an empty message of header's message_type.
 
     Args:
-        header (Header): Unpacked OpenFlow Header.
+        header (~pyof.v0x04.common.header.Header): Unpacked OpenFlow Header.
 
     Returns:
         Empty OpenFlow message of the same type of message_type attribute from