Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
.linkcheckerrc		.linkcheckerrc
Advanced-Topics.rst		Advanced-Topics.rst
Development-Guide.rst		Development-Guide.rst
Experiments.rst		Experiments.rst
FAQ.rst		FAQ.rst
Features.rst		Features.rst
GPU-Performance.rst		GPU-Performance.rst
GPU-Targets.rst		GPU-Targets.rst
GPU-Tutorial.rst		GPU-Tutorial.rst
GPU-Windows.rst		GPU-Windows.rst
Installation-Guide.rst		Installation-Guide.rst
Key-Events.md		Key-Events.md
Makefile		Makefile
Parallel-Learning-Guide.rst		Parallel-Learning-Guide.rst
Parameters-Tuning.rst		Parameters-Tuning.rst
Parameters.rst		Parameters.rst
Python-API.rst		Python-API.rst
Python-Intro.rst		Python-Intro.rst
Quick-Start.rst		Quick-Start.rst
README.rst		README.rst
conf.py		conf.py
gcc-Tips.rst		gcc-Tips.rst
index.rst		index.rst
make.bat		make.bat

README.rst

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