doc: Add PCAP file library reference

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

2 files changed, 28 insertions, 0 deletions

diff --git a/doc/source/library.rst b/doc/source/library.rst
index bc8ff67f..ccdcae30 100644
--- a/doc/source/library.rst
+++ b/doc/source/library.rst
@@ -9,6 +9,7 @@ Ryu provides some useful library for your network applications.
 
    library_packet.rst
    library_packet_ref.rst
+   library_pcap.rst
    library_of_config.rst
    library_bgp_speaker.rst
    library_bgp_speaker_ref.rst
diff --git a/doc/source/library_pcap.rst b/doc/source/library_pcap.rst
new file mode 100644
index 00000000..2eb3fe5e
--- /dev/null
+++ b/doc/source/library_pcap.rst
@@ -0,0 +1,27 @@
+*****************
+PCAP file library
+*****************
+
+Introduction
+============
+
+Ryu PCAP file library helps you to read/write PCAP file which file
+format are described in `The Wireshark Wiki`_.
+
+.. _The Wireshark Wiki: https://wiki.wireshark.org/Development/LibpcapFileFormat
+
+Reading PCAP file
+=================
+
+For loading the packet data containing in PCAP files, you can use
+pcaplib.Reader.
+
+.. autoclass:: ryu.lib.pcaplib.Reader
+
+Writing PCAP file
+=================
+
+For dumping the packet data which your RyuApp received, you can use
+pcaplib.Writer.
+
+.. autoclass:: ryu.lib.pcaplib.Writer