Skip to content

Commit

Permalink
[Doc] Add docs index page
Browse files Browse the repository at this point in the history
Signed-off-by: pdmurray <peynmurray@gmail.com>
  • Loading branch information
peytondmurray committed Nov 14, 2023
1 parent fb5635f commit c4e05a1
Show file tree
Hide file tree
Showing 4 changed files with 268 additions and 105 deletions.
130 changes: 130 additions & 0 deletions doc/source/_static/css/splash.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
.image-header {
display: flex;
flex-direction: row;
align-items: center;
padding-left: 16px;
padding-right:16px;
gap: 16px;
}

.info-box {
background-color: var(--pst-color-surface);
box-shadow: 0px 4px 20px rgba(0, 0, 0, 0.05);
border-radius: 8px;
padding: 20px;
}

.info-box:hover{
box-shadow: 0px 4px 20px rgba(0, 0, 0, 0.1);
}

.no-underline{
text-decoration: none;
}
.no-underline:hover{
text-decoration: none;
}

.icon-hover:hover{
height: 30px ;
width: 30px;
}

.info-box-2 {
background-color: var(--pst-color-surface);
border-radius: 8px;
padding-right: 16px;
padding-left: 16px;
padding-bottom: 24px;
padding-top: 4px;
}


.bold-link {
color: var(--pst-color-link) !important;
font-weight: 600;
}

.community-box {
border: 1px solid var(--pst-color-border);
border-radius: 8px;
display: flex;
margin-bottom: 16px;
}

.community-box:hover {
box-shadow: 0px 4px 20px rgba(0, 0, 0, 0.05);
text-decoration: none;
}

.community-box p {
margin-top: 1rem !important;
}

.tab-pane pre {
margin: 0;
padding: 0;
max-height: 252px;
overflow-y: auto;
animation: fadeEffect 1s; /* Fading effect takes 1 second */
}

.grid-container {
display: grid;
grid-template-columns: repeat(3, 1fr);
grid-gap: 16px;
}

.grid-item {
padding: 20px;
}

.nav-pills {
background-color: var(--pst-color-surface);
padding: 8px;
border-bottom:none;
border-radius: 8px;
}

.nav-pills .nav-link.active {
background-color: var(--pst-color-background) !important;
box-shadow: 0px 3px 14px 2px var(--pst-color-shadow);
border-radius: 8px;
padding-top: 1rem;
padding-bottom: 1rem;
color: var(--pst-color-text-base);
font-weight: 500;
}

#v-pills-tab > .nav-link:hover {
text-decoration: none;
}

#v-pills-tab > a {
cursor: pointer;
}

#v-pills-tab > .nav-link {
color: var(--pst-color-text-base);
}

#v-pills-tabContent {
box-shadow: 0px 6px 30px 5px var(--pst-color-shadow);
border-radius:8px;
}

#v-pills-data {
user-select: none;
}

/* Go from zero to full opacity */
@keyframes fadeEffect {
from {opacity: 0;}
to {opacity: 1;}
}

#ray-intro-video {
width: 100%;
height: 100%;
border-radius: 10px;
}
26 changes: 26 additions & 0 deletions doc/source/_static/js/splash.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
function animateTabs() {
const tabs = Array.from(document.getElementById("v-pills-tab").children)
const contentTabs = Array.from(document.getElementById("v-pills-tabContent").children)

tabs.forEach((item, index) => {
item.onclick = () => {
tabs.forEach((tab, i) => {
if (i === index) {
item.classList.add('active')
} else {
tab.classList.remove('active')
}
})
contentTabs.forEach((tab, i) => {
if (i === index) {
tab.classList.add('active', 'show')
} else {
tab.classList.remove('active', 'show')
}
})
}
})
}

document.addEventListener("DOMContentLoaded", animateTabs)
document.addEventListener("DOMContentLoaded", () => hljs.highlightAll())
28 changes: 28 additions & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
:html_theme.sidebar_secondary.remove:

.. title:: Welcome to Ray!

.. toctree::
:hidden:

Overview <ray-overview/index>
Getting Started <ray-overview/getting-started>
Installation <ray-overview/installation>
Use Cases <ray-overview/use-cases>
Example Gallery <ray-overview/examples>
Ecosystem <ray-overview/ray-libraries>
Ray Core <ray-core/walkthrough>
Ray Data <data/data>
Ray Train <train/train>
Ray Tune <tune/index>
Ray Serve <serve/index>
Ray RLlib <rllib/index>
More Libraries <ray-more-libs/index>
Ray Clusters <cluster/getting-started>
Monitoring and Debugging <ray-observability/index>
Developer Guides <ray-contribute/index>
Glossary <ray-references/glossary>
Security <ray-security/index>

.. raw:: html
:file: splash.html
Loading

0 comments on commit c4e05a1

Please sign in to comment.