enable basic sphinx doc

2015-08-01 11:27:13 -07:00
parent 8083c30e7b
commit c43fee541d
14 changed files with 529 additions and 56 deletions
--- a/doc/python/python_api.rst
+++ b/doc/python/python_api.rst
@@ -0,0 +1,36 @@
+Python API Reference
+====================
+This page gives the Python API reference of xgboost.
+
+Core Data Structure
+-------------------
+.. automodule:: xgboost.core
+
+.. autoclass:: xgboost.DMatrix
+    :members:
+    :show-inheritance:
+
+.. autoclass:: xgboost.Booster
+    :members:
+    :show-inheritance:
+
+
+Learning API
+------------
+.. automodule:: xgboost.training
+
+.. autofunction:: xgboost.train
+
+.. autofunction:: xgboost.cv
+
+
+Scikit-Learn API
+----------------
+.. automodule:: xgboost.sklearn
+.. autoclass:: xgboost.XGBRegressor
+    :members:
+    :show-inheritance:
+.. autoclass:: xgboost.XGBClassifier
+    :members:
+    :show-inheritance:
+