[docs] move wiki to Read the Docs (#945)

* fixed Python-API references

* moved Features section to ReadTheDocs

* fixed index of ReadTheDocs

* moved Experiments section to ReadTheDocs

* fixed capital letter

* fixed citing

* moved Parallel Learning section to ReadTheDocs

* fixed markdown

* fixed Python-API

* fixed link to Quick-Start

* fixed gpu docker README

* moved Installation Guide from wiki to ReadTheDocs

* removed references to wiki

* fixed capital letters in headings

* hotfixes

* fixed non-Unicode symbols and reference to Python API

* fixed citing references

* fixed links in .md files

* fixed links in .rst files

* store images locally in the repo

* fixed missed word

* fixed indent in Experiments.rst

* fixed 'Duplicate implicit target name' message which is successfully
resolved by adding anchors

* less verbose

* prevented maito: ref creation

* fixed indents

* fixed 404

* fixed 403

* fixed 301

* fixed fake anchors

* fixed file extentions

* fixed Sphinx warnings

* added StrikerRUS profile link to FAQ

* added henry0312 profile link to FAQ

docs/_static/js/rst_links_fix.js

+window.onload = function() {
+    $('a[href^="./"][href$=".md"]').attr('href', (i, val) => { return val.replace('.md', '.html'); });  /* Replace '.md' with '.html' in all internal links like './[Something].md' */
+    $('a[href^="./"][href$=".rst"]').attr('href', (i, val) => { return val.replace('.rst', '.html'); });  /* Replace '.rst' with '.html' in all internal links like './[Something].rst' */
+}

docs/conf.py

@@ -180,10 +180,11 @@ texinfo_documents = [
 
 
 # https://recommonmark.readthedocs.io/en/latest/
-github_doc_root = 'https://github.com/Microsoft/LightGBM/tree/master/docs'
+github_doc_root = 'https://github.com/Microsoft/LightGBM/tree/master/docs/'
 def setup(app):
     app.add_config_value('recommonmark_config', {
             'url_resolver': lambda url: github_doc_root + url,
             'auto_toc_tree_section': 'Contents',
             }, True)
     app.add_transform(AutoStructify)
+    app.add_javascript("js/rst_links_fix.js")

docs/development.rst

@@ -4,7 +4,7 @@ Development Guide
 Algorithms
 ----------
 
-Refer to `Features <https://github.com/Microsoft/LightGBM/wiki/Features>`__ to understand important algorithms used in LightGBM.
+Refer to `Features <./Features.md>`__ to understand important algorithms used in LightGBM.
 
 Classes and Code Structure
 --------------------------
@@ -13,7 +13,7 @@ Important Classes
 ~~~~~~~~~~~~~~~~~
 
 +-------------------------+--------------------------------------------------------------------------------------+
-| Class                   | description                                                                          |
+| Class                   | Description                                                                          |
 +=========================+======================================================================================+
 | ``Application``         | The entrance of application, including training and prediction logic                 |
 +-------------------------+--------------------------------------------------------------------------------------+
@@ -44,7 +44,7 @@ Code Structure
 ~~~~~~~~~~~~~~
 
 +---------------------+------------------------------------------------------------------------------------------------------------------------------------+
-| Path                | description                                                                                                                        |
+| Path                | Description                                                                                                                        |
 +=====================+====================================================================================================================================+
 | ./include           | Header files                                                                                                                       |
 +---------------------+------------------------------------------------------------------------------------------------------------------------------------+
@@ -65,11 +65,13 @@ Code Structure
 | ./src/treelearner   | Implementations of tree learners                                                                                                   |
 +---------------------+------------------------------------------------------------------------------------------------------------------------------------+
 
-API Documents
+Documents API
 ~~~~~~~~~~~~~
 
 LightGBM support use `doxygen <http://www.stack.nl/~dimitri/doxygen/>`__ to generate documents for classes and functions.
 
+Refer to `docs README <./README.md>`__.
+
 C API
 -----
 
@@ -78,9 +80,11 @@ Refere to the comments in `c\_api.h <https://github.com/Microsoft/LightGBM/blob/
 High Level Language Package
 ---------------------------
 
-See the implementations at `python-package <https://github.com/Microsoft/LightGBM/tree/master/python-package>`__ and `R-package <https://github.com/Microsoft/LightGBM/tree/master/R-package>`__.
+See the implementations at `Python-package <https://github.com/Microsoft/LightGBM/tree/master/python-package>`__ and `R-package <https://github.com/Microsoft/LightGBM/tree/master/R-package>`__.
+
+Questions
+---------
 
-Ask Questions
--------------
+Refer to `FAQ <./FAQ.md>`__.
 
-Feel free to open `issues <https://github.com/Microsoft/LightGBM/issues>`__ if you met problems.
+Also feel free to open `issues <https://github.com/Microsoft/LightGBM/issues>`__ if you met problems.

docs/index.rst

@@ -10,22 +10,21 @@ Welcome to LightGBM's documentation!
    :maxdepth: 1
    :caption: Contents:
 
-   Installation Guide <https://github.com/Microsoft/LightGBM/wiki/Installation-Guide>
+   Installation Guide <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>
+   Features <Features>
+   Experiments <Experiments>
    Parameters <Parameters>
-   Advanced Topics <Advanced-Topic>
    Parameters Tuning <Parameters-tuning>
-   Python API Reference <python/lightgbm>
-   Parallel Learning Guide <https://github.com/Microsoft/LightGBM/wiki/Parallel-Learning-Guide>
+   Python API <Python-API>
+   Parallel Learning Guide <Parallel-Learning-Guide>
    GPU Tutorial <GPU-Tutorial>
+   Advanced Topics <Advanced-Topic>
    FAQ <FAQ>
    Development Guide <development>
 
-Indices and tables
+Indices and Tables
 ==================
 
 * :ref:`genindex`
-* :ref:`search`

examples/README.md

 Examples
-=====================
-
-You can learn how to use LightGBM by these examples. If you have any questions, please refer to our [wiki](https://github.com/Microsoft/LightGBM/wiki). 
+========
 
+You can learn how to use LightGBM by these examples.

examples/binary_classification/README.md

@@ -5,7 +5,8 @@ Here is an example for LightGBM to run binary classification task.
 
 ***You should copy executable file to this folder first.***
 
-#### Training
+Trainin
+-------
 
 For Windows, by running following command in this folder:
 
@@ -19,7 +20,8 @@ For Linux, by running following command in this folder:
 ./lightgbm config=train.conf
 ```
 
-#### Prediction
+Prediction
+----------
 
 You should finish training first.
 

examples/lambdarank/README.md

@@ -5,7 +5,8 @@ Here is an example for LightGBM to run lambdarank task.
 
 ***You should copy executable file to this folder first.***
 
-#### Training
+Training
+--------
 
 For Windows, by running following command in this folder:
 
@@ -19,7 +20,8 @@ For Linux, by running following command in this folder:
 ./lightgbm config=train.conf
 ```
 
-#### Prediction
+Prediction
+----------
 
 You should finish training first.
 

examples/multiclass_classification/README.md

@@ -5,7 +5,8 @@ Here is an example for LightGBM to run multiclass classification task.
 
 ***You should copy executable file to this folder first.***
 
-#### Training
+Training
+--------
 
 For Windows, by running following command in this folder:
 
@@ -19,7 +20,8 @@ For Linux, by running following command in this folder:
 ./lightgbm config=train.conf
 ```
 
-#### Prediction
+Prediction
+----------
 
 You should finish training first.
 

examples/parallel_learning/README.md

 Parallel Learning Example
 =========================
+
 Here is an example for LightGBM to perform parallel learning for 2 machines.
 
 1. Edit mlist.txt, write the ip of these 2 machines that you want to run application on.
@@ -19,4 +20,4 @@ Here is an example for LightGBM to perform parallel learning for 2 machines.
 
 This parallel learning example is based on socket. LightGBM also support parallel learning based on mpi.
 
-For more details about the usage of parallel learning, please refer to [this](https://github.com/Microsoft/LightGBM/wiki/Parallel-Learning-Guide).
+For more details about the usage of parallel learning, please refer to [this](https://github.com/Microsoft/LightGBM/blob/master/docs/Parallel-Learning-Guide.rst).

examples/python-guide/README.md

 Python Package Examples
 =======================
 
-Here is an example for LightGBM to use python package.
+Here is an example for LightGBM to use Python-package.
 
-***You should install lightgbm (both c++ and python verion) first.***
-
-For the installation, check the wiki [here](https://github.com/Microsoft/LightGBM/wiki/Installation-Guide).
+You should install LightGBM [Python-package](https://github.com/Microsoft/LightGBM/tree/master/python-package) first.
 
 You also need scikit-learn, pandas and matplotlib (only for plot example) to run the examples, but they are not required for the package itself. You can install them with pip:
 

examples/regression/README.md

 Regression Example
 ==================
+
 Here is an example for LightGBM to run regression task.
 
 ***You should copy executable file to this folder first.***
 
-#### Training
+Training
+--------
 
 For Windows, by running following command in this folder:
 
@@ -18,7 +20,8 @@ For Linux, by running following command in this folder:
 ./lightgbm config=train.conf
 ```
 
-#### Prediction
+Prediction
+----------
 
 You should finish training first.