docs: add basic contents to table of contetns (#490)

microsoft · May 4, 2017 · 2a64bfe · 2a64bfe
1 parent ca30b8c
commit 2a64bfe
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 4 deletions.
diff --git a/docs/FAQ.md b/docs/FAQ.md
@@ -1,11 +1,11 @@
 LightGBM FAQ
 =======================
 
-###Catalog
+### Catalog
 
 - [Python-package](FAQ.md#python-package)
 
-###Python-package
+### Python-package
 
 - **Question 1**: I see error messages like this when install from github using `python setup.py install`.
 

diff --git a/docs/Parameters-tuning.md b/docs/Parameters-tuning.md
@@ -1,3 +1,5 @@
+# Parameters Tuning
+
 This is a page contains all parameters in LightGBM.
 
 ***List of other Helpful Links***

diff --git a/docs/Parameters.md b/docs/Parameters.md
@@ -1,3 +1,5 @@
+# Parameters
+
 This is a page contains all parameters in LightGBM.
 
 ***List of other Helpful Links***

diff --git a/docs/Python-API.md b/docs/Python-API.md
@@ -1,3 +1,5 @@
+# Python API Reference
+
 ## Catalog
 
 * [Data Structure API](Python-API.md#basic-data-structure-api)

diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md
@@ -1,3 +1,5 @@
+# Quick Start
+
 This is a quick start guide for LightGBM of cli version.
 
 Follow the [Installation Guide](./Installation-Guide.md) to install LightGBM first.

diff --git a/docs/index.rst b/docs/index.rst
@@ -7,10 +7,21 @@ Welcome to LightGBM's documentation!
 ====================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
-
+   Installation Guide <https://github.com/Microsoft/LightGBM/wiki/Installation-Guide>
+   Quick Start <Quick-Start>
+   Python Quick Start <Python-intro>
+   Features <https://github.com/Microsoft/LightGBM/wiki/Features>
+   Experiments <https://github.com/Microsoft/LightGBM/wiki/Experiments>
+   Parameters <Parameters>
+   Parameters Tuning <Parameters-tuning>
+   Python API Reference <Python-API>
+   Parallel Learning Guide <https://github.com/Microsoft/LightGBM/wiki/Parallel-Learning-Guide>
+   GPU Tutorial <GPU-Tutorial>
+   FAQ <FAQ>
+   Development Guide <development>
 
 Indices and tables
 ==================