try rst

dmlc · Jul 28, 2015 · fcf0f43 · fcf0f43
1 parent cbc21ae
commit fcf0f43
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 0 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -0,0 +1,24 @@
+Rabit Documentation
+=====================
+rabit is a light weight library that provides a fault tolerant interface of Allreduce and Broadcast. It is designed to support easy implementations of distributed machine learning programs, many of which fall naturally under the Allreduce abstraction. The goal of rabit is to support **portable** , **scalable** and **reliable** distributed machine learning programs.
+
+API Documents
+=============
+```eval_rst
+
+.. toctree::
+   :maxdepth: 2
+
+   python_api.md
+   cpp_api.md
+   parameters.md
+   guide.md
+```
+Indices and tables
+==================
+
+```eval_rst
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+```
diff --git a/doc/cpp_api.md b/doc/cpp_api.md
@@ -0,0 +1,9 @@
+C++ Library API of Rabit
+========================
+This page contains document of Library API of rabit.
+
+```eval_rst
+.. toctree::
+
+.. doxygennamespace:: rabit
+```
diff --git a/doc/python_api.md b/doc/python_api.md
@@ -0,0 +1,11 @@
+Python API of Rabit
+===================
+This page contains document of python API of rabit.
+
+```eval_rst
+.. toctree::
+
+.. automodule:: rabit
+    :members:
+    :show-inheritance:
+```