Change the theme to sphinx_rtd

Cloud-CV · Jul 4, 2018 · 0158295 · 0158295
1 parent 312b4c0
commit 0158295
Show file tree

Hide file tree

Showing 24 changed files with 130 additions and 5 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -6,7 +6,7 @@ SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = EvalAICLI
 SOURCEDIR     = .
-BUILDDIR      = _build
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/_static/css/evalai_theme.css b/docs/_static/css/evalai_theme.css
@@ -0,0 +1,114 @@
+@import url("theme.css");
+
+body {
+    font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;
+}
+
+/* Default header fonts are ugly */
+h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend, p.caption {
+    font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;
+}
+
+/* Use white for docs background */
+.wy-side-nav-search {
+    background-color: #fff;
+}
+
+.wy-nav-content-wrap, .wy-menu li.current > a  {
+    background-color: #fff;
+}
+
+@media screen and (min-width: 1400px) {
+    .wy-nav-content-wrap {
+        background-color: rgba(0, 0, 0, 0.0470588);
+    }
+
+    .wy-nav-content {
+        background-color: #fff;
+    }
+}
+
+/* Fixes for mobile */
+.wy-nav-top {
+    background-color: #fff;
+    background-image: url('');
+    background-repeat: no-repeat;
+    background-position: center;
+    padding: 0;
+    margin: 0.4045em 0.809em;
+    color: #333;
+}
+
+.wy-nav-top > a {
+    display: none;
+}
+
+.wy-side-nav-search>a img.logo {
+    padding: 0px;
+}
+
+/* This is needed to ensure that logo above search scales properly */
+.wy-side-nav-search a {
+    display: block;
+}
+
+/* This ensures that multiple constructors will remain in separate lines. */
+.rst-content dl:not(.docutils) dt {
+    display: table;
+}
+
+/* Use our red for literals (it's very similar to the original color) */
+.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal {
+    color: #CE3239;
+}
+
+.rst-content tt.xref, a .rst-content tt, .rst-content tt.xref,
+.rst-content code.xref, a .rst-content tt, a .rst-content code {
+    color: #404040;
+}
+
+/* Change link colors (except for the menu) */
+
+a {
+    color: #CE3239;
+}
+
+a:hover {
+    color: #CE3239;
+}
+
+
+a:visited {
+    color: #c02b46;
+}
+
+.wy-menu a {
+    color: #b3b3b3;
+}
+
+.wy-menu a:hover {
+    color: #b3b3b3;
+}
+
+/* Default footer text is quite big */
+footer {
+    font-size: 80%;
+}
+
+footer .rst-footer-buttons {
+    font-size: 125%; /* revert footer settings - 1/80% = 125% */
+}
+
+footer p {
+    font-size: 100%;
+}
+
+/* For hidden headers that appear in TOC tree */
+/* see http://stackoverflow.com/a/32363545/3343043 */
+.rst-content .hidden-section {
+    display: none;
+}
+
+nav .hidden-section {
+    display: inherit;
+}
diff --git a/docs/_static/img/act-obs-dict.png b/docs/_static/img/act-obs-dict.png
diff --git a/docs/_static/img/aod-ex.png b/docs/_static/img/aod-ex.png
diff --git a/docs/_static/img/datasets.png b/docs/_static/img/datasets.png
diff --git a/docs/_static/img/main.png b/docs/_static/img/main.png
diff --git a/docs/_static/img/messenger-example.png b/docs/_static/img/messenger-example.png
diff --git a/docs/_static/img/mturk-small.png b/docs/_static/img/mturk-small.png
diff --git a/docs/_static/img/mturk.png b/docs/_static/img/mturk.png
diff --git a/docs/_static/img/parlai.png b/docs/_static/img/parlai.png
diff --git a/docs/_static/img/parlai_fairlogo.png b/docs/_static/img/parlai_fairlogo.png
diff --git a/docs/_static/img/personachat_example.png b/docs/_static/img/personachat_example.png
diff --git a/docs/_static/img/task_tutorial_skateboard.jpg b/docs/_static/img/task_tutorial_skateboard.jpg
diff --git a/docs/_static/img/taskntalk.png b/docs/_static/img/taskntalk.png
diff --git a/docs/_static/img/tasks.png b/docs/_static/img/tasks.png
diff --git a/docs/_static/img/tasks2.png b/docs/_static/img/tasks2.png
diff --git a/docs/_static/img/world_basic.png b/docs/_static/img/world_basic.png
diff --git a/docs/_static/img/world_batchagent.png b/docs/_static/img/world_batchagent.png
diff --git a/docs/_static/img/world_batchbasic.png b/docs/_static/img/world_batchbasic.png
diff --git a/docs/_static/img/world_batchboth.png b/docs/_static/img/world_batchboth.png
diff --git a/docs/_static/img/world_batchteacher.png b/docs/_static/img/world_batchteacher.png
diff --git a/docs/_static/img/world_hogwild.png b/docs/_static/img/world_hogwild.png
diff --git a/docs/_static/img/world_share.png b/docs/_static/img/world_share.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -14,6 +14,9 @@
 #
 import os
 import sys
+import sphinx_rtd_theme
+
+from recommonmark.parser import CommonMarkParser
 
 
 sys.path.insert(0, os.path.abspath('../'))
@@ -43,6 +46,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -51,8 +55,8 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
+# source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'
@@ -72,13 +76,17 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+source_parsers = {
+    '.md': CommonMarkParser,
+}
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # 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
@@ -91,6 +99,9 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+html_style = 'css/evalai_theme.css'
+
+
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
@@ -159,4 +170,4 @@
 ]
 
 
-# -- Extension configuration -------------------------------------------------
+# -- Extension configuration -------------------------------------------------