[doc] Fix sklearn doc error, introduce MyST markdown parser (ray-proj…

…ect#21527)
pabloem · Jan 12, 2022 · 703c161 · 703c161
1 parent 54dd2d0
commit 703c161
Show file tree

Hide file tree

Showing 8 changed files with 727 additions and 732 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -3,7 +3,7 @@
 To compile the documentation, run the following commands from this directory.
 Note that Ray must be installed first.
 
-```
+```bash
 pip install -r requirements-doc.txt
 pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
 make html
@@ -12,13 +12,13 @@ open _build/html/index.html
 
 To test if there are any build errors with the documentation, do the following.
 
-```
-sphinx-build -b html -d _build/doctrees source _build/html
+```bash
+sphinx-build -W -b html -d _build/doctrees source _build/html
 ```
 
 To check if there are broken links, run the following (we are currently not running this
 in the CI since there are false positives).
 
-```
+```bash
 make linkcheck
 ```
diff --git a/doc/requirements-doc.txt b/doc/requirements-doc.txt
@@ -38,3 +38,4 @@ git+https://github.com/ray-project/lightgbm_ray@main#lightgbm_ray
 git+https://github.com/ray-project/ray_lightning#ray_lightning
 scikit-optimize
 sphinx-sitemap==2.2.0
+myst-parser
diff --git a/doc/requirements-rtd.txt b/doc/requirements-rtd.txt
@@ -1,6 +1,6 @@
 Pygments==2.3.1
 setuptools==41.0.1
-docutils==0.15
+docutils==0.16
 mock==1.0.1
 pillow==8.3.2
 alabaster>=0.7,<0.8,!=0.7.5
@@ -10,3 +10,4 @@ sphinx==3.0.4
 readthedocs-sphinx-ext<1.1
 sphinx-book-theme==0.0.42
 sphinx-sitemap==2.2.0
+myst-parser