From 803f1de24539db4652170fb3caf60fb78a8f3630 Mon Sep 17 00:00:00 2001 From: Jo Stichbury Date: Tue, 31 Oct 2023 11:29:34 +0000 Subject: [PATCH 1/8] Update docs front page Signed-off-by: Jo Stichbury --- docs/source/index.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/source/index.md b/docs/source/index.md index caaa0b1877..e037e400f3 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,17 +1,17 @@ -```{image} https://raw.githubusercontent.com/kedro-org/kedro/main/static/img/kedro_banner.png -:alt: Kedro logo -:class: kedro-logo -``` - # Welcome to Kedro-Viz documentation! +

+ +![Kedro-Viz Pipeline Visualisation](https://raw.githubusercontent.com/kedro-org/kedro-viz/main/.github/img/banner.png) + +

Kedro-Viz is an interactive development tool for building data science pipelines with [Kedro](https://github.com/kedro-org/kedro). Kedro-Viz also allows users to view and compare different runs in the Kedro project. Kedro-Viz features include: โœจ Complete visualisation of a Kedro project and its pipelines. -๐ŸŽจ Support for light & dark themes out of the box. +โ˜ฏ Support for light & dark themes out of the box. ๐Ÿš€ Scalable to big pipelines with hundreds of nodes. ๐Ÿ”Ž Highly interactive, filterable and searchable. ๐Ÿ”ฌ Focus mode for modular pipeline visualisation. @@ -21,6 +21,7 @@ Kedro-Viz features include: ๐Ÿงช Support for experiment tracking and comparing runs in a Kedro project. +Check out the [live demo](https://demo.kedro.org/) for a preview of Kedro-Viz. ```{toctree} :caption: Learn about Kedro-Viz From 9e33f30366f8bd1553fdda1e0326ea9156972f0b Mon Sep 17 00:00:00 2001 From: Tynan DeBold Date: Tue, 31 Oct 2023 12:07:31 +0000 Subject: [PATCH 2/8] Remove nav_version next to Kedro logo in top left; add Kedro logo Signed-off-by: Tynan DeBold --- docs/source/_templates/layout.html | 6 ------ docs/source/kedro_logo.svg | 3 +++ 2 files changed, 3 insertions(+), 6 deletions(-) create mode 100644 docs/source/kedro_logo.svg diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index f4cf55a471..4b99cb3b11 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -10,12 +10,6 @@ {%- endif %} - - {%- if theme_display_version %} {%- set nav_version = version %} {%- if - READTHEDOCS and current_version %} {%- set nav_version = current_version %} - {%- endif %} {%- if nav_version %} -
{{ nav_version }}
- {%- endif %} {%- endif %}
diff --git a/docs/source/kedro_logo.svg b/docs/source/kedro_logo.svg new file mode 100644 index 0000000000..e3c139a523 --- /dev/null +++ b/docs/source/kedro_logo.svg @@ -0,0 +1,3 @@ + + + From 58ee9f596f0b284d51f58b2906396de163e837b8 Mon Sep 17 00:00:00 2001 From: Jo Stichbury Date: Tue, 31 Oct 2023 12:29:32 +0000 Subject: [PATCH 3/8] Revise project name and author name Signed-off-by: Jo Stichbury --- docs/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index a099ddf4e3..5a7b040d18 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,8 +22,8 @@ # -- Project information ----------------------------------------------------- -project = "kedro-viz" -author = "kedro-viz" +project = "kedro" +author = "kedro" # The short X.Y version. version = re.match(r"^([0-9]+\.[0-9]+).*", release).group(1) From 25a4d4877f81273eee95059a474647762258fbcb Mon Sep 17 00:00:00 2001 From: Tynan DeBold Date: Tue, 31 Oct 2023 14:24:26 +0000 Subject: [PATCH 4/8] Use full kedro icon and type for logo Signed-off-by: Tynan DeBold --- docs/source/_templates/layout.html | 3 +-- docs/source/conf.py | 2 ++ docs/source/kedro-horizontal-color-on-light.svg | 8 ++++++++ 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 docs/source/kedro-horizontal-color-on-light.svg diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index 4b99cb3b11..14b9316aed 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -5,8 +5,7 @@ {%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %} {%- set _root_doc = root_doc|default(master_doc) %} - {% if not theme_logo_only %}{{ project }}{% endif %} {%- if logo or - logo_url %} + {%- if logo or logo_url %} {%- endif %} diff --git a/docs/source/conf.py b/docs/source/conf.py index a099ddf4e3..8a200f89a9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -62,6 +62,8 @@ # a list of builtin themes. # html_theme = "sphinx_rtd_theme" +here = Path(__file__).parent.absolute() +html_logo = str(here / "kedro-horizontal-color-on-light.svg") # Theme options are theme-specific and customise the look and feel of a theme diff --git a/docs/source/kedro-horizontal-color-on-light.svg b/docs/source/kedro-horizontal-color-on-light.svg new file mode 100644 index 0000000000..77feed1a0f --- /dev/null +++ b/docs/source/kedro-horizontal-color-on-light.svg @@ -0,0 +1,8 @@ + + + + + + + + From 7739fe2a2e6875fa4435199639be91e9fab55317 Mon Sep 17 00:00:00 2001 From: Vladimir Date: Thu, 2 Nov 2023 11:16:55 +0100 Subject: [PATCH 5/8] Add mobile nav close btn --- docs/source/_templates/layout.html | 35 +++++++++++++++++++----------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index a1cbef663b..89b94394ce 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -12,7 +12,7 @@
- Kedro + Kedro Kedro-Viz Kedro-Datasets
@@ -20,22 +20,31 @@ {%- include "searchbox.html" %} -{% endblock %} - -{%- block extrahead %} +{% endblock %} {%- block extrahead %} - - {% endblock %} From a7f67cf65280d8696ae81bf361f1b7986ea0484d Mon Sep 17 00:00:00 2001 From: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com> Date: Thu, 2 Nov 2023 11:19:57 +0100 Subject: [PATCH 6/8] Move code for adding btn to event listener --- docs/source/_templates/layout.html | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index 89b94394ce..4c4dcbbd24 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -30,12 +30,14 @@ document.addEventListener("DOMContentLoaded", function() { var sidebarSearch = document.querySelector('.wy-side-nav-search div[role="search"]'); sidebarSearch.parentNode.insertBefore(document.querySelector('.wy-main-nav').cloneNode(true), sidebarSearch); - }); - // Prepend close icon to mobile header + + // Prepend close icon to mobile header var closeBtn = document.querySelector('.wy-nav-top i.fa-bars').cloneNode(true); closeBtn.classList.remove('fa-bars'); closeBtn.classList.add('fa-times'); document.querySelector('.wy-nav-top').prepend(closeBtn) + }); + Date: Thu, 2 Nov 2023 13:04:04 +0100 Subject: [PATCH 7/8] Add css for mobile nav image background --- docs/source/_templates/layout.html | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index 4c4dcbbd24..906d6a82bc 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -49,4 +49,9 @@ href="https://kedro-shared-files.s3.eu-west-2.amazonaws.com/theme-overrides.css" type="text/css" /> + {% endblock %} From 6cbf7f81995ba02f6debfd215ba2eb1b6fbeb296 Mon Sep 17 00:00:00 2001 From: vladimir-mck <106236933+vladimir-mck@users.noreply.github.com> Date: Fri, 3 Nov 2023 15:10:54 +0100 Subject: [PATCH 8/8] Update close button for mobile nav --- docs/source/_templates/layout.html | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index 906d6a82bc..9679811c6f 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -31,12 +31,11 @@ var sidebarSearch = document.querySelector('.wy-side-nav-search div[role="search"]'); sidebarSearch.parentNode.insertBefore(document.querySelector('.wy-main-nav').cloneNode(true), sidebarSearch); - // Prepend close icon to mobile header - var closeBtn = document.querySelector('.wy-nav-top i.fa-bars').cloneNode(true); - closeBtn.classList.remove('fa-bars'); - closeBtn.classList.add('fa-times'); - document.querySelector('.wy-nav-top').prepend(closeBtn) - }); + // Prepend close button to mobile header + var closeBtn = document.createElement("span"); + closeBtn.dataset.toggle = 'wy-nav-top'; + closeBtn.classList.add('wy-nav-top-close'); + document.querySelector('.wy-nav-top').prepend(closeBtn); - {% endblock %}