Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
_static
.linkcheckerrc
Advanced-Topics.rst
C-API.rst
Development-Guide.rst
Experiments.rst
FAQ.rst
Features.rst
GPU-Performance.rst
GPU-Targets.rst
GPU-Tutorial.rst
GPU-Windows.rst
Installation-Guide.rst
Key-Events.md
Makefile
Parallel-Learning-Guide.rst
Parameters-Tuning.rst
Parameters.rst
Python-API.rst
Python-Intro.rst
Quick-Start.rst
README.rst
conf.py
gcc-Tips.rst
index.rst
make.bat
requirements.txt
requirements_base.txt

README.rst

Documentation

Documentation for LightGBM is generated using Sphinx and Breathe, which works on top of Doxygen output.

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 install Doxygen and run in docs folder

pip install -r requirements.txt
make html

Unfortunately, documentation for R code is built only on our site, and commands above will not build it for you locally. Consider using common R utilities for documentation generation, if you need it.

If you faced any problems with Doxygen installation or you simply do not need documentation for C code, it is possible to build the documentation without it:

pip install -r requirements_base.txt
export C_API=NO || set C_API=NO
make html
You can’t perform that action at this time.