[docs] Small aesthetic improvements to RTD docs (#2060)

* Small aesthetic improvements to RTD docs

* fixed markdown table in Development-Guide

* removed unnecessary blank line in conf.py

docs/Development-Guide.rst

@@ -54,7 +54,7 @@ Code Structure
 +---------------------+------------------------------------------------------------------------------------------------------------------------------------+
 | ./src/boosting      | Implementations of Boosting                                                                                                        |
 +---------------------+------------------------------------------------------------------------------------------------------------------------------------+
-| ./src/io            | Implementations of IO relatived classes, including ``Bin``, ``Config``, ``Dataset``, ``DatasetLoader``, ``Feature`` and ``Tree``   |
+| ./src/io            | Implementations of IO related classes, including ``Bin``, ``Config``, ``Dataset``, ``DatasetLoader``, ``Feature`` and ``Tree``     |
 +---------------------+------------------------------------------------------------------------------------------------------------------------------------+
 | ./src/metric        | Implementations of metrics                                                                                                         |
 +---------------------+------------------------------------------------------------------------------------------------------------------------------------+

docs/Experiments.rst

@@ -121,31 +121,31 @@ Accuracy
 
 We computed all accuracy metrics only on the test data set.
 
-+-----------+-----------------+----------+---------------+----------+
-| Data      | Metric          | xgboost  | xgboost\_hist | LightGBM |
-+===========+=================+==========+===============+==========+
-| Higgs     | AUC             | 0.839593 | 0.845605      | 0.845154 |
-+-----------+-----------------+----------+---------------+----------+
-| Yahoo LTR | NDCG\ :sub:`1`  | 0.719748 | 0.720223      | 0.732466 |
-|           +-----------------+----------+---------------+----------+
-|           | NDCG\ :sub:`3`  | 0.717813 | 0.721519      | 0.738048 |
-|           +-----------------+----------+---------------+----------+
-|           | NDCG\ :sub:`5`  | 0.737849 | 0.739904      | 0.756548 |
-|           +-----------------+----------+---------------+----------+
-|           | NDCG\ :sub:`10` | 0.78089  | 0.783013      | 0.796818 |
-+-----------+-----------------+----------+---------------+----------+
-| MS LTR    | NDCG\ :sub:`1`  | 0.483956 | 0.488649      | 0.524255 |
-|           +-----------------+----------+---------------+----------+
-|           | NDCG\ :sub:`3`  | 0.467951 | 0.473184      | 0.505327 |
-|           +-----------------+----------+---------------+----------+
-|           | NDCG\ :sub:`5`  | 0.472476 | 0.477438      | 0.510007 |
-|           +-----------------+----------+---------------+----------+
-|           | NDCG\ :sub:`10` | 0.492429 | 0.496967      | 0.527371 |
-+-----------+-----------------+----------+---------------+----------+
-| Expo      | AUC             | 0.756713 | 0.777777      | 0.777543 |
-+-----------+-----------------+----------+---------------+----------+
-| Allstate  | AUC             | 0.607201 | 0.609042      | 0.609167 |
-+-----------+-----------------+----------+---------------+----------+
++-----------+-----------------+----------+-------------------+--------------+
+| Data      | Metric          | xgboost  | xgboost\_hist     | LightGBM     |
++===========+=================+==========+===================+==============+
+| Higgs     | AUC             | 0.839593 | **0.845605**      | 0.845154     |
++-----------+-----------------+----------+-------------------+--------------+
+| Yahoo LTR | NDCG\ :sub:`1`  | 0.719748 | 0.720223          | **0.732466** |
+|           +-----------------+----------+-------------------+--------------+
+|           | NDCG\ :sub:`3`  | 0.717813 | 0.721519          | **0.738048** |
+|           +-----------------+----------+-------------------+--------------+
+|           | NDCG\ :sub:`5`  | 0.737849 | 0.739904          | **0.756548** |
+|           +-----------------+----------+-------------------+--------------+
+|           | NDCG\ :sub:`10` | 0.78089  | 0.783013          | **0.796818** |
++-----------+-----------------+----------+-------------------+--------------+
+| MS LTR    | NDCG\ :sub:`1`  | 0.483956 | 0.488649          | **0.524255** |
+|           +-----------------+----------+-------------------+--------------+
+|           | NDCG\ :sub:`3`  | 0.467951 | 0.473184          | **0.505327** |
+|           +-----------------+----------+-------------------+--------------+
+|           | NDCG\ :sub:`5`  | 0.472476 | 0.477438          | **0.510007** |
+|           +-----------------+----------+-------------------+--------------+
+|           | NDCG\ :sub:`10` | 0.492429 | 0.496967          | **0.527371** |
++-----------+-----------------+----------+-------------------+--------------+
+| Expo      | AUC             | 0.756713 | **0.777777**      | 0.777543     |
++-----------+-----------------+----------+-------------------+--------------+
+| Allstate  | AUC             | 0.607201 | 0.609042          | **0.609167** |
++-----------+-----------------+----------+-------------------+--------------+
 
 Memory Consumption
 ''''''''''''''''''

docs/Installation-Guide.rst

@@ -54,7 +54,7 @@ With GUI
 
    If you have errors about **Platform Toolset**, go to ``PROJECT`` -> ``Properties`` -> ``Configuration Properties`` -> ``General`` and select the toolset installed on your machine.
 
-The exe file will be in ``LightGBM-master/windows/x64/Release`` folder.
+The ``.exe`` file will be in ``LightGBM-master/windows/x64/Release`` folder.
 
 From Command Line
 *****************
@@ -72,7 +72,7 @@ From Command Line
      cmake -DCMAKE_GENERATOR_PLATFORM=x64 ..
      cmake --build . --target ALL_BUILD --config Release
 
-The exe and dll files will be in ``LightGBM/Release`` folder.
+The ``.exe`` and ``.dll`` files will be in ``LightGBM/Release`` folder.
 
 MinGW-w64
 ^^^^^^^^^
@@ -90,7 +90,7 @@ MinGW-w64
      cmake -G "MinGW Makefiles" ..
      mingw32-make.exe -j4
 
-The exe and dll files will be in ``LightGBM/`` folder.
+The ``.exe`` and ``.dll`` files will be in ``LightGBM/`` folder.
 
 **Note**: You may need to run the ``cmake -G "MinGW Makefiles" ..`` one more time if you encounter the ``sh.exe was found in your PATH`` error.
 

docs/Python-Intro.rst

@@ -42,6 +42,12 @@ The LightGBM Python module can load data from:
 
 The data is stored in a ``Dataset`` object.
 
+Many of the examples in this page use functionality from ``numpy``. To run the examples, be sure to import ``numpy`` in your session.
+
+.. code:: python
+
+    import numpy as np
+
 **To load a libsvm text file or a LightGBM binary file into Dataset:**
 
 .. code:: python
@@ -60,6 +66,7 @@ The data is stored in a ``Dataset`` object.
 
 .. code:: python
 
+    import scipy
     csr = scipy.sparse.csr_matrix((dat, (row, col)))
     train_data = lgb.Dataset(csr)
 

docs/conf.py

@@ -77,10 +77,16 @@ author = 'Microsoft Corporation'
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-version = ''
-# The full version, including alpha/beta/rc tags.
-release = ''
+BASE_DIR = os.path.abspath('../')
+VERSION_FILE = os.path.join(BASE_DIR, "VERSION.txt")
+
+with open(VERSION_FILE, 'r') as f:
+
+    # The short X.Y version.
+    version = f.read().strip()
+
+    # The full version, including alpha/beta/rc tags.
+    release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.