Skip to content

Commit

Permalink
[Doc] Add navbar machinery
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 76e49e8
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/source/_static/img/ray_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions doc/source/_templates/navbar-anyscale.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<a href="https://www.anyscale.com">
<div id="try-anyscale">
<svg id="anyscale-logo" style="margin-top:-3px" width="20" height="20" viewBox="0 0 48 49" xmlns="http://www.w3.org/2000/svg">
<path d="M29.9599 18.4984H42.2138C43.7544 18.509 45.2281 19.1288 46.3124 20.2223C47.3968 21.3158 48.0036 22.7938 48 24.3332V42.6119C47.9965 44.1512 47.3829 45.6265 46.2935 46.7149C45.2042 47.8034 43.7277 48.4164 42.1871 48.42H32.1915C30.6509 48.4164 29.1745 47.8034 28.0851 46.7149C26.9957 45.6265 26.3821 44.1512 26.3786 42.6119V22.0634H5.81292C4.27233 22.0599 2.79584 21.4468 1.70647 20.3583C0.6171 19.2699 0.00352944 17.7946 0 16.2553V6.26809C0.00352944 4.72878 0.6171 3.25353 1.70647 2.16507C2.79584 1.07661 4.27233 0.463548 5.81292 0.460022H24.147C25.6876 0.463548 27.1641 1.07661 28.2535 2.16507C29.3428 3.25353 29.9564 4.72878 29.9599 6.26809V18.4984ZM4.21603 17.8375C4.63956 18.2607 5.21397 18.4984 5.81292 18.4984H26.392V6.25473C26.392 5.65628 26.1541 5.08234 25.7305 4.65917C25.307 4.236 24.7326 3.9983 24.1336 3.9983H5.81292C5.21397 3.9983 4.63956 4.236 4.21603 4.65917C3.79251 5.08234 3.55457 5.65628 3.55457 6.25473V16.2419C3.55457 16.8404 3.79251 17.4143 4.21603 17.8375ZM43.8107 44.1941C44.2342 43.771 44.4721 43.197 44.4721 42.5985V24.3465C44.4721 23.7481 44.2342 23.1742 43.8107 22.751C43.3872 22.3278 42.8128 22.0901 42.2138 22.0901H29.9599V42.5985C29.9599 43.197 30.1978 43.771 30.6214 44.1941C31.0449 44.6173 31.6193 44.855 32.2183 44.855H42.2138C42.8128 44.855 43.3872 44.6173 43.8107 44.1941ZM5.82633 26.6965H15.9822C17.5228 26.7 18.9993 27.313 20.0887 28.4015C21.1781 29.4899 21.7916 30.9652 21.7952 32.5045V42.6519C21.7916 44.1912 21.1781 45.6665 20.0887 46.755C18.9993 47.8434 17.5228 48.4565 15.9822 48.46H5.82633C4.28574 48.4565 2.80925 47.8434 1.71988 46.755C0.630507 45.6665 0.0169572 44.1912 0.0134277 42.6519V32.5045C0.0169572 30.9652 0.630507 29.4899 1.71988 28.4015C2.80925 27.313 4.28574 26.7 5.82633 26.6965ZM17.5791 44.3143C18.0027 43.8911 18.2406 43.3172 18.2406 42.7187V32.5713C18.2406 31.9728 18.0027 31.3989 17.5791 30.9757C17.1556 30.5526 16.5812 30.3148 15.9822 30.3148H5.82633C5.22738 30.3148 4.65296 30.5526 4.22944 30.9757C3.80592 31.3989 3.56798 31.9728 3.56798 32.5713V42.7187C3.56798 43.3172 3.80592 43.8911 4.22944 44.3143C4.65296 44.7374 5.22738 44.9751 5.82633 44.9751H15.9822C16.5812 44.9751 17.1556 44.7374 17.5791 44.3143Z" />
</svg>
<span>Managed Ray on Anyscale</span>
<i class="fas fa-chevron-right" aria-hidden="true" title="Hide"></i>
</div>
</a>
9 changes: 9 additions & 0 deletions doc/source/_templates/navbar-links.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<nav class="navbar-nav">
<p class="sidebar-header-items__title"
role="heading"
aria-level="1"
aria-label="{{ _('Site Navigation') }}">
{{ _("Site Navigation") }}
</p>
{{ render_header_nav_links() }}
</nav>
13 changes: 13 additions & 0 deletions doc/source/_templates/navbar-ray-logo.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{# Logo link generation -#}
{% if not theme_logo.get("link") %}
{% set href = pathto(root_doc) %}
{% elif hasdoc(theme_logo.get("link")) %}
{% set href = pathto(theme_logo.get("link")) %} {# internal page #}
{% else %}
{% set href = theme_logo.get("link") %} {# external url #}
{% endif %}

{#- Logo HTML and image #}
<a class="navbar-brand logo" href="{{ href }}">
{{ theme_logo["svg"] }}
</a>
53 changes: 53 additions & 0 deletions doc/source/navbar.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
- file: ray-overview/getting-started
title: "Getting Started"
- file: ray-overview/use-cases
title: "Use Cases"
- file: ray-overview/examples
title: "Example Gallery"
- file: ray-overview/installation
title: "Libraries"
sections:
- file: ray-core/walkthrough
title: Ray Core
caption: Scale general Python applications
- file: data/data
title: Ray Data
caption: Scale data ingest and preprocessing
- file: train/train
title: Ray Train
caption: Scale machine learning training
- file: tune/index
title: Ray Tune
caption: Scale hyperparameter tuning
- file: serve/index
title: Ray Serve
caption: Scale model serving
- file: rllib/index
title: Ray RLlib
caption: Scale reinforcement learning
- file: index
title: "Docs"
- link: https://discuss.ray.io
title: "Resources"
sections:
- link: https://discuss.ray.io
title: "Discussion Forum"
caption: Get your Ray questions answered
- link: https://github.com/ray-project/ray-educational-materials
title: "Training"
caption: Hands-on learning
- link: https://www.anyscale.com/blog
title: "Blog"
caption: Updates, best practices, user-stories
- link: https://www.anyscale.com/events
title: "Events"
caption: Webinars, meetups, office hours
- link: https://www.anyscale.com/blog/how-ray-and-anyscale-make-it-easy-to-do-massive-scale-machine-learning-on
title: "Success Stories"
caption: Real-world workload examples
- file: ray-overview/ray-libraries
title: "Ecosystem"
caption: Libraries integrated with Ray
- link: https://www.ray.io/community
title: "Community"
caption: Connect with us

0 comments on commit 76e49e8

Please sign in to comment.