Add a landing page for the documentation

To make thinks shinny and cool, add a landing page instead of using the Sphinx index page. Signed-off-by: Pablo Galindo <pablogsal@gmail.com>
bloomberg · Jun 30, 2023 · 33bfff2 · 33bfff2
1 parent 0074091
commit 33bfff2
Show file tree

Hide file tree

Showing 9 changed files with 774 additions and 0 deletions.
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
diff --git a/docs/_static/images/box.png b/docs/_static/images/box.png
diff --git a/docs/_static/images/locals.png b/docs/_static/images/locals.png
diff --git a/docs/_static/images/native.png b/docs/_static/images/native.png
diff --git a/docs/_static/images/python.png b/docs/_static/images/python.png
diff --git a/docs/_static/images/stack.png b/docs/_static/images/stack.png
diff --git a/docs/_static/js/custom.js b/docs/_static/js/custom.js
@@ -0,0 +1,19 @@
+function reveal() {
+  var classes = [".reveal_l", ".reveal_r"];
+  classes.map(function (c) {
+    var reveals = document.querySelectorAll(c);
+    for (var i = 0; i < reveals.length; i++) {
+      var windowHeight = window.innerHeight;
+      var elementTop = reveals[i].getBoundingClientRect().top;
+      var elementVisible = 150;
+      if (elementTop < windowHeight - elementVisible) {
+        reveals[i].classList.add("active");
+      } else {
+        reveals[i].classList.remove("active");
+      }
+    }
+  });
+}
+window.addEventListener("scroll", reveal);
+// To check the scroll position on page load
+reveal();
diff --git a/docs/_templates/index.html b/docs/_templates/index.html
diff --git a/docs/conf.py b/docs/conf.py
@@ -36,6 +36,11 @@
     "sidebar_hide_name": True,
 }
 
+templates_path = ["_templates"]
+html_additional_pages = {
+    "index": "index.html",
+}
+
 # -- Options for smartquotes ----------------------------------------------------------
 
 # Disable the conversion of dashes so that long options like "--find-links" won't