README.rst 522 Bytes
Newer Older
1
2
3
4
5
6
7
8
9
10
Documentation
=============

Documentation for LightGBM is generated using `Sphinx <http://www.sphinx-doc.org/>`__.

After each commit on ``master``, documentation is updated and published to `Read the Docs <https://lightgbm.readthedocs.io/>`__.

Build
-----

11
12
13
You can build the documentation locally. Just run in ``docs`` folder

for Python 3.x:
14
15
16

.. code:: sh

17
    pip install sphinx "sphinx_rtd_theme>=0.3"
18
    make html
19
20
21
22
23
24

 
for Python 2.x:

.. code:: sh

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