Documentation

Documentation for LightGBM is generated using Sphinx.

List of parameters and their descriptions in Parameters.rst is generated automatically from comments in config file by this script.

After each commit on master, documentation is updated and published to Read the Docs.

Build

You can build the documentation locally. Just run in docs folder

for Python 3.x:

pip install sphinx "sphinx_rtd_theme>=0.3"
make html

for Python 2.x:

pip install mock sphinx "sphinx_rtd_theme>=0.3"
make html