97c3a80a34
- Group C API. - Add C API sphinx doc. - Consistent use of `OptionalArg` and the parameter name `config`. - Remove call to deprecated functions in demo. - Fix some formatting errors. - Add links to c examples in the document (only visible with doxygen pages) - Fix arrow.
31 lines
1.0 KiB
ReStructuredText
31 lines
1.0 KiB
ReStructuredText
##########################
|
|
Documentation and Examples
|
|
##########################
|
|
|
|
**Contents**
|
|
|
|
.. contents::
|
|
:backlinks: none
|
|
:local:
|
|
|
|
*********
|
|
Documents
|
|
*********
|
|
* Python and C documentation is built using `Sphinx <http://www.sphinx-doc.org/en/master/>`_.
|
|
* Each document is written in `reStructuredText <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_.
|
|
* You can build document locally to see the effect, by running
|
|
|
|
.. code-block:: bash
|
|
|
|
make html
|
|
|
|
inside the ``doc/`` directory. The online document is hosted by `Read the Docs <https://readthedocs.org/>`__ where the imported project is managed by `Hyunsu Cho <https://github.com/hcho3>`__ and `Jiaming Yuan <https://github.com/trivialfis>`__.
|
|
|
|
********
|
|
Examples
|
|
********
|
|
* Use cases and examples will be in `demo <https://github.com/dmlc/xgboost/tree/master/demo>`_.
|
|
* We are super excited to hear about your story. If you have blog posts,
|
|
tutorials, or code solutions using XGBoost, please tell us, and we will add
|
|
a link in the example pages.
|