Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Draft, not ready] Update docs front page following design review #1617

Merged
merged 13 commits into from
Nov 8, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,10 @@
{%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1))
%} {%- set _root_doc = root_doc|default(master_doc) %}
<a href="{{ pathto(_root_doc) }}">
{% if not theme_logo_only %}{{ project }}{% endif %} {%- if logo or
logo_url %}
{%- if logo or logo_url %}
<img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}" />
{%- endif %}
</a>

{%- if theme_display_version %} {%- set nav_version = version %} {%- if
READTHEDOCS and current_version %} {%- set nav_version = current_version %}
{%- endif %} {%- if nav_version %}
<div class="wy-header-version">{{ nav_version }}</div>
{%- endif %} {%- endif %}
</div>

<div class="wy-main-nav">
Expand Down
6 changes: 4 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
13 changes: 7 additions & 6 deletions docs/source/index.md
Original file line number Diff line number Diff line change
@@ -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!

<p align="center">

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

</p>

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.
Expand All @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/source/kedro-horizontal-color-on-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/source/kedro_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.