From: Shinpei Muraoka <[email protected]> To keep readablity if include all class into library reference, this patch separates library_packet_ref.rst into each protocol.
Signed-off-by: Shinpei Muraoka <[email protected]> --- doc/source/library_packet_ref.rst | 174 +--------------------- doc/source/library_packet_ref/packet_arp.rst | 6 + doc/source/library_packet_ref/packet_base.rst | 6 + doc/source/library_packet_ref/packet_bfd.rst | 6 + doc/source/library_packet_ref/packet_bgp.rst | 6 + doc/source/library_packet_ref/packet_bmp.rst | 6 + doc/source/library_packet_ref/packet_bpdu.rst | 6 + doc/source/library_packet_ref/packet_cfm.rst | 6 + doc/source/library_packet_ref/packet_dhcp.rst | 6 + doc/source/library_packet_ref/packet_dhcp6.rst | 6 + doc/source/library_packet_ref/packet_ethernet.rst | 6 + doc/source/library_packet_ref/packet_geneve.rst | 6 + doc/source/library_packet_ref/packet_gre.rst | 6 + doc/source/library_packet_ref/packet_icmp.rst | 6 + doc/source/library_packet_ref/packet_icmpv6.rst | 6 + doc/source/library_packet_ref/packet_igmp.rst | 6 + doc/source/library_packet_ref/packet_ipv4.rst | 6 + doc/source/library_packet_ref/packet_ipv6.rst | 6 + doc/source/library_packet_ref/packet_llc.rst | 6 + doc/source/library_packet_ref/packet_lldp.rst | 6 + doc/source/library_packet_ref/packet_mpls.rst | 6 + doc/source/library_packet_ref/packet_openflow.rst | 6 + doc/source/library_packet_ref/packet_ospf.rst | 6 + doc/source/library_packet_ref/packet_pbb.rst | 6 + doc/source/library_packet_ref/packet_sctp.rst | 6 + doc/source/library_packet_ref/packet_slow.rst | 6 + doc/source/library_packet_ref/packet_tcp.rst | 6 + doc/source/library_packet_ref/packet_udp.rst | 6 + doc/source/library_packet_ref/packet_vlan.rst | 6 + doc/source/library_packet_ref/packet_vrrp.rst | 6 + doc/source/library_packet_ref/packet_vxlan.rst | 6 + doc/source/library_packet_ref/packet_zebra.rst | 6 + 32 files changed, 193 insertions(+), 167 deletions(-) create mode 100644 doc/source/library_packet_ref/packet_arp.rst create mode 100644 doc/source/library_packet_ref/packet_base.rst create mode 100644 doc/source/library_packet_ref/packet_bfd.rst create mode 100644 doc/source/library_packet_ref/packet_bgp.rst create mode 100644 doc/source/library_packet_ref/packet_bmp.rst create mode 100644 doc/source/library_packet_ref/packet_bpdu.rst create mode 100644 doc/source/library_packet_ref/packet_cfm.rst create mode 100644 doc/source/library_packet_ref/packet_dhcp.rst create mode 100644 doc/source/library_packet_ref/packet_dhcp6.rst create mode 100644 doc/source/library_packet_ref/packet_ethernet.rst create mode 100644 doc/source/library_packet_ref/packet_geneve.rst create mode 100644 doc/source/library_packet_ref/packet_gre.rst create mode 100644 doc/source/library_packet_ref/packet_icmp.rst create mode 100644 doc/source/library_packet_ref/packet_icmpv6.rst create mode 100644 doc/source/library_packet_ref/packet_igmp.rst create mode 100644 doc/source/library_packet_ref/packet_ipv4.rst create mode 100644 doc/source/library_packet_ref/packet_ipv6.rst create mode 100644 doc/source/library_packet_ref/packet_llc.rst create mode 100644 doc/source/library_packet_ref/packet_lldp.rst create mode 100644 doc/source/library_packet_ref/packet_mpls.rst create mode 100644 doc/source/library_packet_ref/packet_openflow.rst create mode 100644 doc/source/library_packet_ref/packet_ospf.rst create mode 100644 doc/source/library_packet_ref/packet_pbb.rst create mode 100644 doc/source/library_packet_ref/packet_sctp.rst create mode 100644 doc/source/library_packet_ref/packet_slow.rst create mode 100644 doc/source/library_packet_ref/packet_tcp.rst create mode 100644 doc/source/library_packet_ref/packet_udp.rst create mode 100644 doc/source/library_packet_ref/packet_vlan.rst create mode 100644 doc/source/library_packet_ref/packet_vrrp.rst create mode 100644 doc/source/library_packet_ref/packet_vxlan.rst create mode 100644 doc/source/library_packet_ref/packet_zebra.rst diff --git a/doc/source/library_packet_ref.rst b/doc/source/library_packet_ref.rst index 48a5fc6..7c9b562 100644 --- a/doc/source/library_packet_ref.rst +++ b/doc/source/library_packet_ref.rst @@ -14,175 +14,15 @@ Stream Parser class .. automodule:: ryu.lib.packet.stream_parser :members: -.. autoclass:: ryu.lib.packet.bgp.StreamParser - :members: +List of the sub-classes: + +- :py:mod:`ryu.lib.packet.bgp.StreamParser` Protocol Header classes ======================= -.. automodule:: ryu.lib.packet.packet_base - :members: - -.. automodule:: ryu.lib.packet.ethernet - :members: - -.. autoclass:: ryu.lib.packet.lldp.lldp - :members: - -.. automodule:: ryu.lib.packet.vlan - :members: - -.. automodule:: ryu.lib.packet.pbb - :members: - -.. automodule:: ryu.lib.packet.mpls - :members: - -.. automodule:: ryu.lib.packet.arp - :members: - -.. automodule:: ryu.lib.packet.ipv4 - :members: - -.. automodule:: ryu.lib.packet.icmp - :members: - -.. automodule:: ryu.lib.packet.ipv6 - :members: - -.. automodule:: ryu.lib.packet.icmpv6 - :members: - -.. automodule:: ryu.lib.packet.vxlan - :members: - -.. automodule:: ryu.lib.packet.geneve - :members: - -.. automodule:: ryu.lib.packet.gre - :members: - -.. automodule:: ryu.lib.packet.cfm - :members: - -.. automodule:: ryu.lib.packet.tcp - :members: - -.. automodule:: ryu.lib.packet.udp - :members: - -.. automodule:: ryu.lib.packet.dhcp - :members: - -.. autoclass:: ryu.lib.packet.dhcp6.dhcp6 - :members: -.. autoclass:: ryu.lib.packet.dhcp6.options - :members: -.. autoclass:: ryu.lib.packet.dhcp6.option - :members: - -.. autoclass:: ryu.lib.packet.vrrp.vrrp - :members: -.. autoclass:: ryu.lib.packet.vrrp.vrrpv2 - :members: -.. autoclass:: ryu.lib.packet.vrrp.vrrpv3 - :members: - -.. autoclass:: ryu.lib.packet.slow.slow - :members: -.. autoclass:: ryu.lib.packet.slow.lacp - :members: - -.. autoclass:: ryu.lib.packet.llc.llc - :members: -.. autoclass:: ryu.lib.packet.llc.ControlFormatI - :members: -.. autoclass:: ryu.lib.packet.llc.ControlFormatS - :members: -.. autoclass:: ryu.lib.packet.llc.ControlFormatU - :members: - -.. autoclass:: ryu.lib.packet.bpdu.bpdu - :members: -.. autoclass:: ryu.lib.packet.bpdu.ConfigurationBPDUs - :members: -.. autoclass:: ryu.lib.packet.bpdu.TopologyChangeNotificationBPDUs - :members: -.. autoclass:: ryu.lib.packet.bpdu.RstBPDUs - :members: - -.. autoclass:: ryu.lib.packet.igmp.igmp - :members: -.. autoclass:: ryu.lib.packet.igmp.igmpv3_query - :members: -.. autoclass:: ryu.lib.packet.igmp.igmpv3_report - :members: -.. autoclass:: ryu.lib.packet.igmp.igmpv3_report_group - :members: - -.. autoclass:: ryu.lib.packet.bgp.BGPMessage - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPOpen - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPUpdate - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPKeepAlive - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPNotification - :members: - -.. autoclass:: ryu.lib.packet.bgp.EvpnEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnArbitraryEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnLACPEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnL2BridgeEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnMacBasedEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnRouterIDEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnASBasedEsi - :members: - -.. autoclass:: ryu.lib.packet.bgp.FlowSpecIPv4NLRI - :members: -.. autoclass:: ryu.lib.packet.bgp.FlowSpecVPNv4NLRI - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecTrafficRateCommunity - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecTrafficActionCommunity - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecRedirectCommunity - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecTrafficMarkingCommunity - :members: - - -.. automodule:: ryu.lib.packet.bmp - :members: - -.. autoclass:: ryu.lib.packet.bfd.bfd - :members: -.. autoclass:: ryu.lib.packet.bfd.SimplePassword - :members: -.. autoclass:: ryu.lib.packet.bfd.KeyedMD5 - :members: -.. autoclass:: ryu.lib.packet.bfd.MeticulousKeyedMD5 - :members: -.. autoclass:: ryu.lib.packet.bfd.KeyedSHA1 - :members: -.. autoclass:: ryu.lib.packet.bfd.MeticulousKeyedSHA1 - :members: - -.. automodule:: ryu.lib.packet.openflow - :members: - -.. autoclass:: ryu.lib.packet.ospf.OSPFMessage - :members: - -.. automodule:: ryu.lib.packet.sctp - :members: +.. toctree:: + :glob: -.. autoclass:: ryu.lib.packet.zebra.ZebraMessage + library_packet_ref/packet_base + library_packet_ref/* \ No newline at end of file diff --git a/doc/source/library_packet_ref/packet_arp.rst b/doc/source/library_packet_ref/packet_arp.rst new file mode 100644 index 0000000..f45dabb --- /dev/null +++ b/doc/source/library_packet_ref/packet_arp.rst @@ -0,0 +1,6 @@ +*** +ARP +*** + +.. automodule:: ryu.lib.packet.arp + :members: diff --git a/doc/source/library_packet_ref/packet_base.rst b/doc/source/library_packet_ref/packet_base.rst new file mode 100644 index 0000000..a63f646 --- /dev/null +++ b/doc/source/library_packet_ref/packet_base.rst @@ -0,0 +1,6 @@ +***************** +Packet Base Class +***************** + +.. automodule:: ryu.lib.packet.packet_base + :members: diff --git a/doc/source/library_packet_ref/packet_bfd.rst b/doc/source/library_packet_ref/packet_bfd.rst new file mode 100644 index 0000000..81ea0a9 --- /dev/null +++ b/doc/source/library_packet_ref/packet_bfd.rst @@ -0,0 +1,6 @@ +*** +BFD +*** + +.. automodule:: ryu.lib.packet.bfd + :members: diff --git a/doc/source/library_packet_ref/packet_bgp.rst b/doc/source/library_packet_ref/packet_bgp.rst new file mode 100644 index 0000000..4db18e2 --- /dev/null +++ b/doc/source/library_packet_ref/packet_bgp.rst @@ -0,0 +1,6 @@ +*** +BGP +*** + +.. automodule:: ryu.lib.packet.bgp + :members: diff --git a/doc/source/library_packet_ref/packet_bmp.rst b/doc/source/library_packet_ref/packet_bmp.rst new file mode 100644 index 0000000..0568796 --- /dev/null +++ b/doc/source/library_packet_ref/packet_bmp.rst @@ -0,0 +1,6 @@ +*** +BMP +*** + +.. automodule:: ryu.lib.packet.bmp + :members: diff --git a/doc/source/library_packet_ref/packet_bpdu.rst b/doc/source/library_packet_ref/packet_bpdu.rst new file mode 100644 index 0000000..52b25af --- /dev/null +++ b/doc/source/library_packet_ref/packet_bpdu.rst @@ -0,0 +1,6 @@ +**** +BPDU +**** + +.. automodule:: ryu.lib.packet.bpdu + :members: diff --git a/doc/source/library_packet_ref/packet_cfm.rst b/doc/source/library_packet_ref/packet_cfm.rst new file mode 100644 index 0000000..dee5417 --- /dev/null +++ b/doc/source/library_packet_ref/packet_cfm.rst @@ -0,0 +1,6 @@ +*** +CFM +*** + +.. automodule:: ryu.lib.packet.cfm + :members: diff --git a/doc/source/library_packet_ref/packet_dhcp.rst b/doc/source/library_packet_ref/packet_dhcp.rst new file mode 100644 index 0000000..d50e349 --- /dev/null +++ b/doc/source/library_packet_ref/packet_dhcp.rst @@ -0,0 +1,6 @@ +**** +DHCP +**** + +.. automodule:: ryu.lib.packet.dhcp + :members: diff --git a/doc/source/library_packet_ref/packet_dhcp6.rst b/doc/source/library_packet_ref/packet_dhcp6.rst new file mode 100644 index 0000000..6e10973 --- /dev/null +++ b/doc/source/library_packet_ref/packet_dhcp6.rst @@ -0,0 +1,6 @@ +***** +DHCP6 +***** + +.. automodule:: ryu.lib.packet.dhcp6 + :members: diff --git a/doc/source/library_packet_ref/packet_ethernet.rst b/doc/source/library_packet_ref/packet_ethernet.rst new file mode 100644 index 0000000..25ff1f2 --- /dev/null +++ b/doc/source/library_packet_ref/packet_ethernet.rst @@ -0,0 +1,6 @@ +******** +Ehternet +******** + +.. automodule:: ryu.lib.packet.ethernet + :members: diff --git a/doc/source/library_packet_ref/packet_geneve.rst b/doc/source/library_packet_ref/packet_geneve.rst new file mode 100644 index 0000000..0af1c13 --- /dev/null +++ b/doc/source/library_packet_ref/packet_geneve.rst @@ -0,0 +1,6 @@ +****** +Geneve +****** + +.. automodule:: ryu.lib.packet.geneve + :members: diff --git a/doc/source/library_packet_ref/packet_gre.rst b/doc/source/library_packet_ref/packet_gre.rst new file mode 100644 index 0000000..d7ffc8e --- /dev/null +++ b/doc/source/library_packet_ref/packet_gre.rst @@ -0,0 +1,6 @@ +*** +GRE +*** + +.. automodule:: ryu.lib.packet.gre + :members: diff --git a/doc/source/library_packet_ref/packet_icmp.rst b/doc/source/library_packet_ref/packet_icmp.rst new file mode 100644 index 0000000..30be76e --- /dev/null +++ b/doc/source/library_packet_ref/packet_icmp.rst @@ -0,0 +1,6 @@ +**** +ICMP +**** + +.. automodule:: ryu.lib.packet.icmp + :members: diff --git a/doc/source/library_packet_ref/packet_icmpv6.rst b/doc/source/library_packet_ref/packet_icmpv6.rst new file mode 100644 index 0000000..77fac38 --- /dev/null +++ b/doc/source/library_packet_ref/packet_icmpv6.rst @@ -0,0 +1,6 @@ +****** +ICMPv6 +****** + +.. automodule:: ryu.lib.packet.icmpv6 + :members: diff --git a/doc/source/library_packet_ref/packet_igmp.rst b/doc/source/library_packet_ref/packet_igmp.rst new file mode 100644 index 0000000..c03ba74 --- /dev/null +++ b/doc/source/library_packet_ref/packet_igmp.rst @@ -0,0 +1,6 @@ +**** +IGMP +**** + +.. automodule:: ryu.lib.packet.igmp + :members: diff --git a/doc/source/library_packet_ref/packet_ipv4.rst b/doc/source/library_packet_ref/packet_ipv4.rst new file mode 100644 index 0000000..e479a61 --- /dev/null +++ b/doc/source/library_packet_ref/packet_ipv4.rst @@ -0,0 +1,6 @@ +**** +IPv4 +**** + +.. automodule:: ryu.lib.packet.ipv4 + :members: diff --git a/doc/source/library_packet_ref/packet_ipv6.rst b/doc/source/library_packet_ref/packet_ipv6.rst new file mode 100644 index 0000000..12a4e25 --- /dev/null +++ b/doc/source/library_packet_ref/packet_ipv6.rst @@ -0,0 +1,6 @@ +**** +IPv6 +**** + +.. automodule:: ryu.lib.packet.ipv6 + :members: diff --git a/doc/source/library_packet_ref/packet_llc.rst b/doc/source/library_packet_ref/packet_llc.rst new file mode 100644 index 0000000..2972e84 --- /dev/null +++ b/doc/source/library_packet_ref/packet_llc.rst @@ -0,0 +1,6 @@ +*** +LLC +*** + +.. automodule:: ryu.lib.packet.llc + :members: diff --git a/doc/source/library_packet_ref/packet_lldp.rst b/doc/source/library_packet_ref/packet_lldp.rst new file mode 100644 index 0000000..e8d7ad6 --- /dev/null +++ b/doc/source/library_packet_ref/packet_lldp.rst @@ -0,0 +1,6 @@ +**** +LLDP +**** + +.. automodule:: ryu.lib.packet.lldp + :members: diff --git a/doc/source/library_packet_ref/packet_mpls.rst b/doc/source/library_packet_ref/packet_mpls.rst new file mode 100644 index 0000000..71dba25 --- /dev/null +++ b/doc/source/library_packet_ref/packet_mpls.rst @@ -0,0 +1,6 @@ +**** +MPLS +**** + +.. automodule:: ryu.lib.packet.mpls + :members: diff --git a/doc/source/library_packet_ref/packet_openflow.rst b/doc/source/library_packet_ref/packet_openflow.rst new file mode 100644 index 0000000..4697d2c --- /dev/null +++ b/doc/source/library_packet_ref/packet_openflow.rst @@ -0,0 +1,6 @@ +******** +OpenFlow +******** + +.. automodule:: ryu.lib.packet.openflow + :members: diff --git a/doc/source/library_packet_ref/packet_ospf.rst b/doc/source/library_packet_ref/packet_ospf.rst new file mode 100644 index 0000000..56a6d98 --- /dev/null +++ b/doc/source/library_packet_ref/packet_ospf.rst @@ -0,0 +1,6 @@ +**** +OSPF +**** + +.. automodule:: ryu.lib.packet.ospf + :members: diff --git a/doc/source/library_packet_ref/packet_pbb.rst b/doc/source/library_packet_ref/packet_pbb.rst new file mode 100644 index 0000000..156c13b --- /dev/null +++ b/doc/source/library_packet_ref/packet_pbb.rst @@ -0,0 +1,6 @@ +*** +PBB +*** + +.. automodule:: ryu.lib.packet.pbb + :members: diff --git a/doc/source/library_packet_ref/packet_sctp.rst b/doc/source/library_packet_ref/packet_sctp.rst new file mode 100644 index 0000000..1ac723b --- /dev/null +++ b/doc/source/library_packet_ref/packet_sctp.rst @@ -0,0 +1,6 @@ +**** +SCTP +**** + +.. automodule:: ryu.lib.packet.sctp + :members: diff --git a/doc/source/library_packet_ref/packet_slow.rst b/doc/source/library_packet_ref/packet_slow.rst new file mode 100644 index 0000000..c579b51 --- /dev/null +++ b/doc/source/library_packet_ref/packet_slow.rst @@ -0,0 +1,6 @@ +**** +Slow +**** + +.. automodule:: ryu.lib.packet.slow + :members: diff --git a/doc/source/library_packet_ref/packet_tcp.rst b/doc/source/library_packet_ref/packet_tcp.rst new file mode 100644 index 0000000..238cee3 --- /dev/null +++ b/doc/source/library_packet_ref/packet_tcp.rst @@ -0,0 +1,6 @@ +*** +TCP +*** + +.. automodule:: ryu.lib.packet.tcp + :members: diff --git a/doc/source/library_packet_ref/packet_udp.rst b/doc/source/library_packet_ref/packet_udp.rst new file mode 100644 index 0000000..0098df5 --- /dev/null +++ b/doc/source/library_packet_ref/packet_udp.rst @@ -0,0 +1,6 @@ +*** +UDP +*** + +.. automodule:: ryu.lib.packet.udp + :members: diff --git a/doc/source/library_packet_ref/packet_vlan.rst b/doc/source/library_packet_ref/packet_vlan.rst new file mode 100644 index 0000000..3166f5b --- /dev/null +++ b/doc/source/library_packet_ref/packet_vlan.rst @@ -0,0 +1,6 @@ +**** +VLAN +**** + +.. automodule:: ryu.lib.packet.vlan + :members: diff --git a/doc/source/library_packet_ref/packet_vrrp.rst b/doc/source/library_packet_ref/packet_vrrp.rst new file mode 100644 index 0000000..ef9d907 --- /dev/null +++ b/doc/source/library_packet_ref/packet_vrrp.rst @@ -0,0 +1,6 @@ +**** +VRRP +**** + +.. automodule:: ryu.lib.packet.vrrp + :members: diff --git a/doc/source/library_packet_ref/packet_vxlan.rst b/doc/source/library_packet_ref/packet_vxlan.rst new file mode 100644 index 0000000..0d80190 --- /dev/null +++ b/doc/source/library_packet_ref/packet_vxlan.rst @@ -0,0 +1,6 @@ +***** +VXLAN +***** + +.. automodule:: ryu.lib.packet.vxlan + :members: diff --git a/doc/source/library_packet_ref/packet_zebra.rst b/doc/source/library_packet_ref/packet_zebra.rst new file mode 100644 index 0000000..af524a1 --- /dev/null +++ b/doc/source/library_packet_ref/packet_zebra.rst @@ -0,0 +1,6 @@ +***** +Zebra +***** + +.. automodule:: ryu.lib.packet.zebra + :members: -- 2.7.4 ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________ Ryu-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/ryu-devel
