Hendrik/xgboost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
xgboost/doc
History
Oleksandr Pryimak 923e6c86ba Add to documentation how to run tests locally (#4610) 
* Add to documentation how to build native unit tests

* Add instructions to run Python tests and to use Docker container [skip ci]

* Fix link to pytest chapter

* Add link to Google Test [skip ci]

* Set PYTHONPATH [skip ci]

* Revise test_python.sh for running tests locally

* Update test_python.sh

* Place Docker recommendation notice in a prominent place [skip ci]
2019-06-27 19:02:04 -07:00
..
_static
Doc modernization (#3474)
2018-07-19 14:22:16 -07:00
gpu
Doc and demo for customized metric and obj. (#4598)
2019-06-26 16:13:12 +08:00
jvm
Doc and demo for customized metric and obj. (#4598)
2019-06-26 16:13:12 +08:00
python
Fix dask API sphinx docstrings (#4507)
2019-05-28 16:39:26 +12:00
R-package
fix typos (#4027)
2018-12-28 00:36:47 +08:00
tutorials
Fix doc for customized objective/metric [skip ci] (#4608)
2019-06-26 13:40:34 -07:00
.gitignore
[DOC] Update R doc
2016-01-16 11:52:33 -08:00
build.rst
Address some sphinx warnings and errors, add doc for building doc. (#4589)
2019-06-20 15:07:36 -07:00
cli.rst
Doc modernization (#3474)
2018-07-19 14:22:16 -07:00
conf.py
[RFC] Version 0.90 release candidate (#4475)
2019-05-20 01:02:44 -07:00
contribute.rst
Add to documentation how to run tests locally (#4610)
2019-06-27 19:02:04 -07:00
Doxyfile.in
Refactor CMake scripts. (#4323)
2019-04-15 10:08:12 -07:00
faq.rst
Update faq.rst (#3521)
2018-07-28 10:34:14 -07:00
get_started.rst
replace nround with nrounds to match actual parameter (#3592)
2018-08-15 11:13:53 -07:00
index.rst
Doc modernization (#3474)
2018-07-19 14:22:16 -07:00
julia.rst
Doc modernization (#3474)
2018-07-19 14:22:16 -07:00
Makefile
enable basic sphinx doc
2015-08-01 11:27:13 -07:00
parameter.rst
Address some sphinx warnings and errors, add doc for building doc. (#4589)
2019-06-20 15:07:36 -07:00
README
Fix doc build (#3126)
2018-02-21 16:57:30 -08:00
requirements.txt
Use Sphinx 2.1+ to compile documentation [skip ci] (#4609)
2019-06-26 16:26:22 -07:00
sphinx_util.py
Doc modernization (#3474)
2018-07-19 14:22:16 -07:00

README 

The documentation of xgboost is generated with recommonmark and sphinx.

You can build it locally by typing "make html" in this folder.

Checkout https://recommonmark.readthedocs.org for guide on how to write markdown with extensions used in this doc, such as math formulas and table of content.