[Doc] Use sphinx_book_theme (#10379)

doc/requirements-doc.txt

@@ -24,7 +24,8 @@ sphinx-gallery
 sphinx-jsonschema
 sphinx-tabs
 sphinx-version-warning
-sphinx_rtd_theme
+# TODO(simon): Use sphinx book theme released version
+git+https://github.com/executablebooks/sphinx-book-theme.git@0a87d26e214c419d2e6efcadddab4be8ae7b2c21
 tabulate
 uvicorn
 werkzeug

doc/requirements-rtd.txt

@@ -7,5 +7,4 @@ alabaster>=0.7,<0.8,!=0.7.5
 commonmark==0.8.1
 recommonmark==0.5.0
 sphinx<2
-sphinx-rtd-theme<0.5
 readthedocs-sphinx-ext<1.1

doc/source/_static/css/custom.css

@@ -1,32 +1,49 @@
 /*Extends the docstring signature box.*/
 .rst-content dl:not(.docutils) dt {
-    display: block;
-    padding: 10px;
-    word-wrap: break-word;
-    padding-right: 100px;
+  display: block;
+  padding: 10px;
+  word-wrap: break-word;
+  padding-right: 100px;
 }
 /*Lists in an admonition note do not have awkward whitespace below.*/
 .rst-content .admonition-note .section ul {
-    margin-bottom: 0px
+  margin-bottom: 0px;
 }
 /*Properties become blue (classmethod, staticmethod, property)*/
 .rst-content dl dt em.property {
-    color: #2980B9;
-    text-transform: uppercase
+  color: #2980b9;
+  text-transform: uppercase;
 }
 
-.rst-content .section ol p, .rst-content .section ul p {
-    margin-bottom: 0px;
+.rst-content .section ol p,
+.rst-content .section ul p {
+  margin-bottom: 0px;
 }
 
 div.sphx-glr-bigcontainer {
-    display: inline-block;
-    width: 100%
+  display: inline-block;
+  width: 100%;
 }
 
-
-td.tune-colab, th.tune-colab {
+td.tune-colab,
+th.tune-colab {
   border: 1px solid #dddddd;
   text-align: left;
   padding: 8px;
 }
+
+/* Adjustment to Sphinx Book Theme */
+.table td {
+  /* Remove row spacing */
+  padding: 0;
+}
+
+table {
+  /* Force full width for all table */
+  width: 136% !important;
+}
+
+img.inline-figure {
+  /* Override the display: block for img */
+  display: inherit !important;
+}

doc/source/conf.py

@@ -125,7 +125,7 @@ versionwarning_messages = {
     ),
 }
 
-versionwarning_body_selector = "div.document"
+versionwarning_body_selector = "#main-content"
 sphinx_gallery_conf = {
     "examples_dirs": ["../examples",
                       "tune/_tutorials"],  # path to example scripts
@@ -233,33 +233,38 @@ todo_include_todos = False
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-import sphinx_rtd_theme
-html_theme = 'sphinx_rtd_theme'
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_theme = "sphinx_book_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+html_theme_options = {
+    "repository_url": "https://github.com/ray-project/ray",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+    "path_to_docs": "doc/source",
+    "home_page_in_toc": True,
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+html_title = f"Ray v{release}"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = "images/ray_logo.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = "_static/favicon.ico"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -280,7 +285,7 @@ html_static_path = ['_static']
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-html_sidebars = {'**': ['index.html']}
+# html_sidebars = {'**': ['index.html']}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.

doc/source/ray-overview/basics.rst

@@ -1,10 +1,4 @@
 
-.. raw:: html
-
-  <embed>
-    <a href="https://github.com/ray-project/ray"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/365986a132ccd6a44c23a9169022c0b5c890c387/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"></a>
-  </embed>
-
 .. image:: https://github.com/ray-project/ray/raw/master/doc/source/images/ray_header_logo.png
 
 **Ray provides a simple, universal API for building distributed applications.**
@@ -13,7 +7,7 @@ Ray accomplishes this mission by:
 
 1. Providing simple primitives for building and running distributed applications.
 2. Enabling end users to parallelize single machine code, with little to zero code changes.
-3. Including a large ecosystem of applications, libraries, and tools on top of the core Ray to enable complex applications. 
+3. Including a large ecosystem of applications, libraries, and tools on top of the core Ray to enable complex applications.
 
 **Ray Core** provides the simple primitives for application building.
 

doc/source/rllib-algorithms.rst

@@ -600,9 +600,11 @@ Tuned examples: `SimpleContextualBandit <https://github.com/ray-project/ray/blob
 
 
 .. |tensorflow| image:: tensorflow.png
+    :class: inline-figure
     :width: 24
 
 .. |pytorch| image:: pytorch.png
+    :class: inline-figure
     :width: 24
 
 

doc/source/rllib-toc.rst

@@ -208,7 +208,9 @@ TensorFlow 2.0
 RLlib currently runs in ``tf.compat.v1`` mode. This means eager execution is disabled by default, and RLlib imports TF with ``import tensorflow.compat.v1 as tf; tf.disable_v2_behaviour()``. Eager execution can be enabled manually by calling ``tf.enable_eager_execution()`` or setting the ``"eager": True`` trainer config.
 
 .. |tensorflow| image:: tensorflow.png
+    :class: inline-figure
     :width: 16
 
 .. |pytorch| image:: pytorch.png
+    :class: inline-figure
     :width: 16

doc/source/rllib.rst

@@ -117,7 +117,9 @@ RLlib provides ways to customize almost all aspects of training, including the `
 To learn more, proceed to the `table of contents <rllib-toc.html>`__.
 
 .. |tensorflow| image:: tensorflow.png
+    :class: inline-figure
     :width: 24
 
 .. |pytorch| image:: pytorch.png
+    :class: inline-figure
     :width: 24