From 76e49e817d9d8a0a02f094188832cec4e4cc7020 Mon Sep 17 00:00:00 2001 From: pdmurray Date: Mon, 13 Nov 2023 20:27:41 -0800 Subject: [PATCH] [Doc] Add navbar machinery Signed-off-by: pdmurray --- doc/source/_static/img/ray_logo.svg | 11 +++++ doc/source/_templates/navbar-anyscale.html | 9 ++++ doc/source/_templates/navbar-links.html | 9 ++++ doc/source/_templates/navbar-ray-logo.html | 13 ++++++ doc/source/navbar.yml | 53 ++++++++++++++++++++++ 5 files changed, 95 insertions(+) create mode 100644 doc/source/_static/img/ray_logo.svg create mode 100644 doc/source/_templates/navbar-anyscale.html create mode 100644 doc/source/_templates/navbar-links.html create mode 100644 doc/source/_templates/navbar-ray-logo.html create mode 100644 doc/source/navbar.yml diff --git a/doc/source/_static/img/ray_logo.svg b/doc/source/_static/img/ray_logo.svg new file mode 100644 index 000000000000..1b8c1e8e4151 --- /dev/null +++ b/doc/source/_static/img/ray_logo.svg @@ -0,0 +1,11 @@ + + + + + + diff --git a/doc/source/_templates/navbar-anyscale.html b/doc/source/_templates/navbar-anyscale.html new file mode 100644 index 000000000000..228fbc952e2b --- /dev/null +++ b/doc/source/_templates/navbar-anyscale.html @@ -0,0 +1,9 @@ + +
+ + Managed Ray on Anyscale + +
+
diff --git a/doc/source/_templates/navbar-links.html b/doc/source/_templates/navbar-links.html new file mode 100644 index 000000000000..0519d6be46d4 --- /dev/null +++ b/doc/source/_templates/navbar-links.html @@ -0,0 +1,9 @@ + diff --git a/doc/source/_templates/navbar-ray-logo.html b/doc/source/_templates/navbar-ray-logo.html new file mode 100644 index 000000000000..9c0cacfce8cb --- /dev/null +++ b/doc/source/_templates/navbar-ray-logo.html @@ -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 #} + diff --git a/doc/source/navbar.yml b/doc/source/navbar.yml new file mode 100644 index 000000000000..61811e302b45 --- /dev/null +++ b/doc/source/navbar.yml @@ -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