Skip to content

Commit 05b0894

Browse files
authored
Doc modernization (dmlc#3474)
* Change doc build to reST exclusively * Rewrite Intro doc in reST; create toctree * Update parameter and contribute * Convert tutorials to reST * Convert Python tutorials to reST * Convert CLI and Julia docs to reST * Enable markdown for R vignettes * Done migrating to reST * Add guzzle_sphinx_theme to requirements * Add breathe to requirements * Fix search bar * Add link to user forum
1 parent c004cea commit 05b0894

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+2833
-3957
lines changed

doc/R-package/index.md

-17
This file was deleted.

doc/R-package/index.rst

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#################
2+
XGBoost R Package
3+
#################
4+
5+
.. raw:: html
6+
7+
<a href="http://cran.r-project.org/web/packages/xgboost"><img alt="CRAN Status Badge" src="http://www.r-pkg.org/badges/version/xgboost"></a>
8+
<a href="http://cran.rstudio.com/web/packages/xgboost/index.html"><img alt="CRAN Downloads" src="http://cranlogs.r-pkg.org/badges/xgboost"></a>
9+
10+
You have found the XGBoost R Package!
11+
12+
***********
13+
Get Started
14+
***********
15+
* Checkout the :doc:`Installation Guide </build>` contains instructions to install xgboost, and :doc:`Tutorials </tutorials/index>` for examples on how to use XGBoost for various tasks.
16+
* Read the `API documentation <https://cran.r-project.org/web/packages/xgboost/xgboost.pdf>`_.
17+
* Please visit `Walk-through Examples <https://github.com/dmlc/xgboost/tree/master/R-package/demo>`_.
18+
19+
*********
20+
Tutorials
21+
*********
22+
23+
.. toctree::
24+
:maxdepth: 2
25+
:titlesonly:
26+
27+
Introduction to XGBoost in R <xgboostPresentation>
28+
Understanding your dataset with XGBoost <discoverYourData>

doc/_static/custom.css

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
div.breathe-sectiondef.container {
2+
width: 100%;
3+
}
4+
5+
div.literal-block-wrapper.container {
6+
width: 100%;
7+
}
8+
9+
.red {
10+
color: red;
11+
}
12+
13+
table {
14+
border: 0;
15+
}
16+
17+
td, th {
18+
padding: 1px 8px 1px 5px;
19+
border-top: 0;
20+
border-bottom: 1px solid #aaa;
21+
border-left: 0;
22+
border-right: 0;
23+
}

0 commit comments

Comments
 (0)