Signed-off-by: YAMAMOTO Takashi <[email protected]>
---
doc/source/conf.py | 2 +-
doc/source/library.rst | 1 +
doc/source/library_packet_ref.rst | 52 +++++++++++++++++++++++++++++++++++++++
3 files changed, 54 insertions(+), 1 deletion(-)
create mode 100644 doc/source/library_packet_ref.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 2494b76..ebccb2c 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 28d3e31..eee6877 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 0000000..10e9cb8
--- /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:
--
1.8.0.1
------------------------------------------------------------------------------
Try New Relic Now & We'll Send You this Cool Shirt
New Relic is the only SaaS-based application performance monitoring service
that delivers powerful full stack analytics. Optimize and monitor your
browser, app, & servers with just a few lines of code. Try New Relic
and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr
_______________________________________________
Ryu-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/ryu-devel
