docs: add theme

.readthedocs.yml

@@ -0,0 +1,23 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt

docs/conf.py

@@ -80,7 +80,15 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'header_links' : [
+        ('Home', 'index', False, 'home'),
+        ("GitHub", "https://github.com/zhenghaoz/gorse", True, 'code'),
+        ("GoDoc", "https://godoc.org/github.com/zhenghaoz/gorse", True, 'book')
+    ],
+    'primary_color': 'blue',
+    'show_drawer_title': False
+}
 
 # 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,

docs/index.html

@@ -86,9 +86,9 @@ <h4><a href="https://godoc.org/github.com/zhenghaoz/gorse" target="_blank"><i
                         <p class="grey-text text-darken-1 start-paragraph-text">GoDoc</p>
                     </div>
                     <div class="col s4 m3 center">
-                        <h4><a href="https://github.com/zhenghaoz/gorse/wiki" target="_blank"><i
+                        <h4><a href="https://gorse.readthedocs.io/en/latest/" target="_blank"><i
                                         class="fas fa-book-open blue-text" style="font-size: 3.2rem"></i></a></h4>
-                        <p class="grey-text text-darken-1 start-paragraph-text">Wiki</p>
+                        <p class="grey-text text-darken-1 start-paragraph-text">ReadTheDocs</p>
                     </div>
                 </div>
             </div>
@@ -185,4 +185,4 @@ <h4><a href="https://t.me/zhenghaoz" target="_blank"><i class="fab fa-telegram b
     M.AutoInit();
 </script>
 </body>
-</html>
+</html>

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx-materialdesign-theme==0.1.11
+