diff options
| author | YAMAMOTO Takashi <yamamoto@valinux.co.jp> | 2013-04-23 18:28:28 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2013-04-24 19:39:39 +0900 |
| commit | 3488d0b82073dc006993d61a4c13ad0b02c3df32 (patch) | |
| tree | f7c7b8e46dd6777c33756b0adc598d651f9711d4 | |
| parent | 3ed8040393f560660343b4770e4d43f4fca006c3 (diff) | |
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>
| -rw-r--r-- | doc/source/conf.py | 2 | ||||
| -rw-r--r-- | doc/source/library.rst | 1 | ||||
| -rw-r--r-- | doc/source/library_packet_ref.rst | 52 |
3 files changed, 54 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 2494b76e..ebccb2c5 100644 --- a/doc/source/conf.py +++ b/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'] diff --git a/doc/source/library.rst b/doc/source/library.rst index 28d3e314..eee6877a 100644 --- a/doc/source/library.rst +++ b/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 diff --git a/doc/source/library_packet_ref.rst b/doc/source/library_packet_ref.rst new file mode 100644 index 00000000..10e9cb84 --- /dev/null +++ b/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: |