diff --git a/README.rst b/README.rst index 1f51b1c2273fc..287a23e9cca60 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,6 @@ +.. image:: ./ray_summit_2023_horizontal.svg + :target: https://raysummit.anyscale.com/?utm_source=github&utm_medium=website&utm_campaign=ray_summit_2023&utm_content=banner + .. image:: https://github.com/ray-project/ray/raw/master/doc/source/images/ray_header_logo.png .. image:: https://readthedocs.org/projects/ray/badge/?version=master @@ -12,8 +15,6 @@ .. image:: https://img.shields.io/twitter/follow/raydistributed.svg?style=social&logo=twitter :target: https://twitter.com/raydistributed -| - Ray is a unified framework for scaling AI and Python applications. Ray consists of a core distributed runtime and a set of AI libraries for simplifying ML compute: .. image:: https://github.com/ray-project/ray/raw/master/doc/source/images/what-is-ray-padded.svg @@ -134,4 +135,3 @@ Getting Involved .. _`Meetup Group`: https://www.meetup.com/Bay-Area-Ray-Meetup/ .. _`Twitter`: https://twitter.com/raydistributed .. _`Slack`: https://forms.gle/9TSdDYUgxYs8SA9e8 - diff --git a/doc/source/_static/css/custom.css b/doc/source/_static/css/custom.css index 4f2fb62816078..299c913804fab 100644 --- a/doc/source/_static/css/custom.css +++ b/doc/source/_static/css/custom.css @@ -1,3 +1,21 @@ +/* override default colors used in the Sphinx theme */ +:root { + --tabs-color-label-active: #0475DE; + --tabs-color-label-hover: #0475DE; + --buttons-color-blue: #0475DE; + --tabs-color-label-inactive: #9E9E9E; + --tabs-color-overline: #e0e0e0; + --tabs-color-underline: #e0e0e0; + --border-color-gray: #e0e0e0; + --background-color-light-gray:#fafafa; + --background-color-disabled: #9E9E9E; + --pst-color-link: 4, 117, 222; + --pst-color-primary: 4, 117, 222; + --pst-color-text-secondary: #616161; + --blue: #0475DE; + --sidebar-top: 5em; +} + /* Remove flicker for announcement top bar replacement */ .header-item.announcement { background-color: white; @@ -28,8 +46,10 @@ div.navbar-brand-box { * height: to prevent topbar overlap */ #site-navigation { - overflow-y: visible; - height: 100% !important; + overflow-y: auto; + height: calc(100vh - var(--sidebar-top)); + position: sticky; + top: var(--sidebar-top) !important; } /* Center the algolia search bar*/ @@ -98,14 +118,7 @@ div.navbar-brand-box { overflow-y: scroll !important; } -/* Make the TOC on the left scrollable by itself */ -#site-navigation .bd-sidebar__content { - height: 80vh; - overflow: visible; -} .bd-sidebar__top { - height: 100%; - overflow: visible; display: flex; flex-direction: column; } @@ -116,9 +129,7 @@ div.navbar-brand-box { } nav.bd-links { - overflow-y: auto; flex: 1; - padding-bottom: 50px; } nav.bd-links::-webkit-scrollbar-thumb { @@ -490,23 +501,6 @@ footer { color: var(--pst-color-text-secondary); } -/* override default colors used in the Sphinx theme */ -:root { - --tabs-color-label-active: #0475DE; - --tabs-color-label-hover: #0475DE; - --buttons-color-blue: #0475DE; - --tabs-color-label-inactive: #9E9E9E; - --tabs-color-overline: #e0e0e0; - --tabs-color-underline: #e0e0e0; - --border-color-gray: #e0e0e0; - --background-color-light-gray:#fafafa; - --background-color-disabled: #9E9E9E; - --pst-color-link: 4, 117, 222; - --pst-color-primary: 4, 117, 222; - --pst-color-text-secondary: #616161; - --blue: #0475DE; -} - /* Make the hover color of tag/gallery buttons differ from "active" */ .tag.btn-outline-primary:hover { background-color: rgba(20, 99, 208, 0.62) !important; @@ -795,3 +789,7 @@ footer.col.footer > p { #csat-textarea { resize: none; } + +.summit-ad { + margin: 1em 0em; +} diff --git a/doc/source/_static/js/summit.js b/doc/source/_static/js/summit.js new file mode 100644 index 0000000000000..d50b335d11cb7 --- /dev/null +++ b/doc/source/_static/js/summit.js @@ -0,0 +1,40 @@ +// Insert an ad for the Ray Summit 2023 with a link to the summit web page. +document.addEventListener("DOMContentLoaded", () => { + const rayVersionLabel = document.querySelector("div.navbar-brand-box") + const wrapper = rayVersionLabel.closest("div.bd-sidebar__top") + + if (wrapper) { + // Remove some unnecessary padding if inserting the Ray Summit ad + rayVersionLabel.style.paddingTop = "0" + + // Insert the ad in the TOC on the left sidebar + const svg = ` + + + + + + + + + + + + + + + + + + + + + + + ` + const summitAd = document.createElement("div") + summitAd.classList.add("summit-ad") + summitAd.innerHTML = `${svg}` + wrapper.insertBefore(summitAd, rayVersionLabel) + } +}) diff --git a/doc/source/conf.py b/doc/source/conf.py index a052c31f96700..edb7f3252df53 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -419,6 +419,7 @@ def setup(app): app.add_js_file("js/custom.js", defer="defer") app.add_js_file("js/top-navigation.js", defer="defer") + app.add_js_file("js/summit.js", defer="defer") base_path = Path(__file__).parent github_docs = DownloadAndPreprocessEcosystemDocs(base_path) diff --git a/ray_summit_2023_horizontal.svg b/ray_summit_2023_horizontal.svg new file mode 100644 index 0000000000000..1685ebe2741fc --- /dev/null +++ b/ray_summit_2023_horizontal.svg @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + +