Skip to content

Commit

Permalink
docs: Add a landing page for the documentation
Browse files Browse the repository at this point in the history
To make thinks shiny and cool, add a landing page instead of using the
Sphinx index page.

Signed-off-by: Pablo Galindo <pablogsal@gmail.com>
  • Loading branch information
pablogsal committed Jul 3, 2023
1 parent 0074091 commit b72b219
Show file tree
Hide file tree
Showing 10 changed files with 789 additions and 0 deletions.
462 changes: 462 additions & 0 deletions docs/_static/css/custom.css

Large diffs are not rendered by default.

Binary file added docs/_static/images/box.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/locals.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/native.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/python.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/stack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/_static/js/custom.js
Original file line number Diff line number Diff line change
@@ -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();
302 changes: 302 additions & 0 deletions docs/_templates/index.html

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@
"sidebar_hide_name": True,
}

templates_path = ["_templates"]
html_additional_pages = {
"index": "index.html",
}
root_doc = "overview"

# -- Options for smartquotes ----------------------------------------------------------

# Disable the conversion of dashes so that long options like "--find-links" won't
Expand Down
File renamed without changes.

0 comments on commit b72b219

Please sign in to comment.