add a template for ryu.lib.packet class documentation.

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

doc/source/conf.py

@@ -26,7 +26,7 @@ from ryu import version as ryu_version
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
+extensions = [ 'sphinx.ext.autodoc' ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

doc/source/library.rst

@@ -8,4 +8,5 @@ Ryu provides some useful library for your network applications.
    :maxdepth: 1
 
    library_packet.rst
+   library_packet_ref.rst
    library_of_config.rst

doc/source/library_packet_ref.rst

@@ -0,0 +1,52 @@
+****************************
+Packet library API Reference
+****************************
+
+Packet class
+============
+
+.. automodule:: ryu.lib.packet.packet
+   :members:
+
+Protocol Header classes
+=======================
+
+.. automodule:: ryu.lib.packet.packet_base
+   :members:
+
+.. automodule:: ryu.lib.packet.ethernet
+   :members:
+
+.. automodule:: ryu.lib.packet.vlan
+   :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.tcp
+   :members:
+
+.. automodule:: ryu.lib.packet.udp
+   :members:
+
+.. autoclass:: ryu.lib.packet.vrrp.vrrp
+   :members:
+.. autoclass:: ryu.lib.packet.vrrp.vrrpv2
+   :members:
+.. autoclass:: ryu.lib.packet.vrrp.vrrpv3
+   :members: