Signed-off-by: IWASE Yusuke <[email protected]>
---
doc/source/library.rst | 1 +
doc/source/library_mrt.rst | 28 ++++++++++++++++++++++++++++
2 files changed, 29 insertions(+)
create mode 100644 doc/source/library_mrt.rst
diff --git a/doc/source/library.rst b/doc/source/library.rst
index ccdcae3..ff28041 100644
--- a/doc/source/library.rst
+++ b/doc/source/library.rst
@@ -13,4 +13,5 @@ Ryu provides some useful library for your network
applications.
library_of_config.rst
library_bgp_speaker.rst
library_bgp_speaker_ref.rst
+ library_mrt.rst
library_ovsdb_manager.rst
diff --git a/doc/source/library_mrt.rst b/doc/source/library_mrt.rst
new file mode 100644
index 0000000..e5fccb2
--- /dev/null
+++ b/doc/source/library_mrt.rst
@@ -0,0 +1,28 @@
+****************
+MRT file library
+****************
+
+Introduction
+============
+
+Ryu MRT file library helps you to read/write MRT
+(Multi-Threaded Routing Toolkit) Routing Information Export Format
+[`RFC6396`_].
+
+.. _RFC6396: https://tools.ietf.org/html/rfc6396
+
+Reading MRT file
+================
+
+For loading the routing information contained in MRT files, you can use
+mrtlib.Reader.
+
+.. autoclass:: ryu.lib.mrtlib.Reader
+
+Writing MRT file
+================
+
+For dumping the routing information which your RyuApp generated, you can use
+mrtlib.Writer.
+
+.. autoclass:: ryu.lib.mrtlib.Writer
--
2.7.4
------------------------------------------------------------------------------
_______________________________________________
Ryu-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/ryu-devel
