[DOC] Update landing page (#122)

* add disclaimer * conf.py update * conf.py update * clean index * toc move around * images * fix and community * furo * furo2 * temp logo * annoying * markdown index * more options * fix * index markdown fixes * images and secondary colour change * aeon title color and links * break * different red * different red * font colour * aeon version and font --------- Co-authored-by: Lukasz Mentel <lmmentel@users.noreply.github.com>
aeon-toolkit · Mar 15, 2023 · d0c06dd · d0c06dd
1 parent 8fed2b2
commit d0c06dd
Show file tree

Hide file tree

Showing 21 changed files with 223 additions and 258 deletions.
diff --git a/docs/source/about/artwork.rst b/docs/source/about/artwork.rst
@@ -4,9 +4,6 @@
 Artwork
 =======
 
-High-quality logos are available in the `docs/source/images/ <https://github.com/aeon-toolkit/aeon/tree/main/docs/source/images>`_ directory on GitHub.
+High-quality logos are available in the `docs/source/images/ <https://github.com/sktime/sktime/tree/main/docs/source/images>`_ directory on GitHub.
 
 The logos were designed by `Miguel Garcia Cabrera <https://www.flickr.com/photos/miguelgarciacabrera/>`_.
-
-.. image:: ../images/aeon-logo-no-text.jpg
-    :align: center
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -9,17 +9,16 @@
 
 import aeon
 
-rst_prolog = """.. attention::
-    DISCLAIMER: This is a fork of the sktime repository. Work is ongoing to change links
-    and documentation to reflect this. We do not recommend using this repository in any
-    production setting, but welcome any contributors willing to help us update the
-    project.
+# -- Project information -----------------------------------------------------
+
+project = "aeon"
+copyright = "The aeon developers (BSD-3 License)"
+author = "aeon developers"
 
-    Join our `Slack`_ to discuss the projects goals, ask usage questions and discuss
-    contributions.
+version = aeon.__version__
+release = aeon.__version__
 
-    .. _Slack: https://join.slack.com/t/scikit-timeworkspace/shared_invite/zt-1pkhua342-W_W24XuAZt2JZU1GniK2YA
-"""  # noqa: E501
+github_tag = f"v{version}"
 
 # -- Path setup --------------------------------------------------------------
 
@@ -46,6 +45,7 @@
     if READTHEDOCS_VERSION == "latest":
         CURRENT_VERSION = "main"
 
+
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -55,14 +55,14 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.autosectionlabel",
-    "numpydoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.linkcode",  # link to GitHub source code via linkcode_resolve()
+    "numpydoc",
     "nbsphinx",  # integrates example notebooks
     "sphinx_gallery.load_style",
-    "myst_parser",
     "sphinx_design",
     "sphinx_issues",
+    "myst_parser",
 ]
 
 # Recommended by sphinx_design when using the MyST Parser
@@ -181,69 +181,90 @@ def find_source():
     except Exception:
         filename = info["module"].replace(".", "/") + ".py"
     return "https://github.com/aeon-toolkit/aeon/blob/%s/%s" % (
-        CURRENT_VERSION,
+        github_tag,
         filename,
     )
 
 
 # -- Options for HTML output -------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-
-html_theme = "pydata_sphinx_theme"
+# The theme to use for HTML.
+html_theme = "furo"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 
 html_theme_options = {
-    "icon_links": [
-        {
-            "name": "GitHub",
-            "url": "https://github.com/aeon-toolkit/aeon",
-            "icon": "fab fa-github",
-        },
+    "sidebar_hide_name": True,
+    "top_of_page_button": "edit",
+    "source_repository": "https://github.com/aeon-toolkit/aeon/",
+    "source_branch": "main",
+    "source_directory": "docs/source/",
+    "light_css_variables": {
+        "color-brand-primary": "#D71414",
+        "color-brand-content": "#EB1414",
+    },
+    "dark_css_variables": {
+        "color-brand-primary": "#FF1414",
+        "color-brand-content": "#EB3C3C",
+    },
+    "footer_icons": [
         {
             "name": "Slack",
-            "url": "https://join.slack.com/t/scikit-timeworkspace/shared_invite/zt-1pkhua342-W_W24XuAZt2JZU1GniK2YA",  # noqa: E501
-            "icon": "fab fa-slack",
+            "url": "https://join.slack.com/t/aeon-toolkit/shared_invite/zt-1plkevy4x-vAg1dAUXcuoR38FjY9nxzg",  # noqa: E501
+            "html": """
+            <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg">
+                <path d="M512 64C264.6 64 64 264.6 64 512s200.6 448 448 448 448-200.6 448-448S759.4 64 512 64zM361.5 580.2c0 27.8-22.5 50.4-50.3 50.4-13.3 0-26.1-5.3-35.6-14.8-9.4-9.5-14.7-22.3-14.7-35.6 0-27.8 22.5-50.4 50.3-50.4h50.3v50.4zm134 134.4c0 27.8-22.5 50.4-50.3 50.4-27.8 0-50.3-22.6-50.3-50.4V580.2c0-27.8 22.5-50.4 50.3-50.4 13.3 0 26.1 5.3 35.6 14.8s14.7 22.3 14.7 35.6v134.4zm-50.2-218.4h-134c-27.8 0-50.3-22.6-50.3-50.4 0-27.8 22.5-50.4 50.3-50.4h134c27.8 0 50.3 22.6 50.3 50.4-.1 27.9-22.6 50.4-50.3 50.4zm0-134.4c-13.3 0-26.1-5.3-35.6-14.8S395 324.8 395 311.4c0-27.8 22.5-50.4 50.3-50.4 27.8 0 50.3 22.6 50.3 50.4v50.4h-50.3zm83.7-50.4c0-27.8 22.5-50.4 50.3-50.4 27.8 0 50.3 22.6 50.3 50.4v134.4c0 27.8-22.5 50.4-50.3 50.4-27.8 0-50.3-22.6-50.3-50.4V311.4zM579.3 765c-27.8 0-50.3-22.6-50.3-50.4v-50.4h50.3c27.8 0 50.3 22.6 50.3 50.4 0 27.8-22.5 50.4-50.3 50.4zm134-134.4h-134c-13.3 0-26.1-5.3-35.6-14.8S529 593.6 529 580.2c0-27.8 22.5-50.4 50.3-50.4h134c27.8 0 50.3 22.6 50.3 50.4 0 27.8-22.5 50.4-50.3 50.4zm0-134.4H663v-50.4c0-27.8 22.5-50.4 50.3-50.4s50.3 22.6 50.3 50.4c0 27.8-22.5 50.4-50.3 50.4z"></path>
+            </svg>
+            """,  # noqa: E501
+            "class": "",
         },
         {
             "name": "LinkedIn",
             "url": "https://www.linkedin.com/company/sktime/",
-            "icon": "fab fa-linkedin",
+            "html": """
+            <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg">
+                <path d="M880 112H144c-17.7 0-32 14.3-32 32v736c0 17.7 14.3 32 32 32h736c17.7 0 32-14.3 32-32V144c0-17.7-14.3-32-32-32zM349.3 793.7H230.6V411.9h118.7v381.8zm-59.3-434a68.8 68.8 0 1 1 68.8-68.8c-.1 38-30.9 68.8-68.8 68.8zm503.7 434H675.1V608c0-44.3-.8-101.2-61.7-101.2-61.7 0-71.2 48.2-71.2 98v188.9H423.7V411.9h113.8v52.2h1.6c15.8-30 54.5-61.7 112.3-61.7 120.2 0 142.3 79.1 142.3 181.9v209.4z"></path>
+            </svg>
+            """,  # noqa: E501
+            "class": "",
         },
         {
             "name": "Twitter",
             "url": "https://twitter.com/sktime_toolbox",
-            "icon": "fab fa-twitter",
+            "html": """
+            <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg">
+                <path d="M928 254.3c-30.6 13.2-63.9 22.7-98.2 26.4a170.1 170.1 0 0 0 75-94 336.64 336.64 0 0 1-108.2 41.2A170.1 170.1 0 0 0 672 174c-94.5 0-170.5 76.6-170.5 170.6 0 13.2 1.6 26.4 4.2 39.1-141.5-7.4-267.7-75-351.6-178.5a169.32 169.32 0 0 0-23.2 86.1c0 59.2 30.1 111.4 76 142.1a172 172 0 0 1-77.1-21.7v2.1c0 82.9 58.6 151.6 136.7 167.4a180.6 180.6 0 0 1-44.9 5.8c-11.1 0-21.6-1.1-32.2-2.6C211 652 273.9 701.1 348.8 702.7c-58.6 45.9-132 72.9-211.7 72.9-14.3 0-27.5-.5-41.2-2.1C171.5 822 261.2 850 357.8 850 671.4 850 843 590.2 843 364.7c0-7.4 0-14.8-.5-22.2 33.2-24.3 62.3-54.4 85.5-88.2z"></path>
+            </svg>
+            """,  # noqa: E501
+            "class": "",
         },
-    ],
-    "favicons": [
         {
-            "rel": "icon",
-            "sizes": "16x16",
-            "href": "images/aeon-favicon.ico",
-        }
+            "name": "GitHub",
+            "url": "https://github.com/aeon-toolkit/aeon",
+            "html": """
+            <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg">
+                <path d="M511.6 76.3C264.3 76.2 64 276.4 64 523.5 64 718.9 189.3 885 363.8 946c23.5 5.9 19.9-10.8 19.9-22.2v-77.5c-135.7 15.9-141.2-73.9-150.3-88.9C215 726 171.5 718 184.5 703c30.9-15.9 62.4 4 98.9 57.9 26.4 39.1 77.9 32.5 104 26 5.7-23.5 17.9-44.5 34.7-60.8-140.6-25.2-199.2-111-199.2-213 0-49.5 16.3-95 48.3-131.7-20.4-60.5 1.9-112.3 4.9-120 58.1-5.2 118.5 41.6 123.2 45.3 33-8.9 70.7-13.6 112.9-13.6 42.4 0 80.2 4.9 113.5 13.9 11.3-8.6 67.3-48.8 121.3-43.9 2.9 7.7 24.7 58.3 5.5 118 32.4 36.8 48.9 82.7 48.9 132.3 0 102.2-59 188.1-200 212.9a127.5 127.5 0 0 1 38.1 91v112.5c.8 9 0 17.9 15 17.9 177.1-59.7 304.6-227 304.6-424.1 0-247.2-200.4-447.3-447.5-447.3z"></path>
+            </svg>
+            """,  # noqa: E501
+            "class": "",
+        },
+        {
+            "name": "ReadTheDocs",
+            "url": "https://readthedocs.org/projects/aeon-toolkit/",
+            "html": """
+            <svg stroke="currentColor" fill="currentColor" stroke-width="0" role="img" viewBox="0 0 24 24" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg">
+                <path d="M7.732 0a59.316 59.316 0 0 0-4.977.218V24a62.933 62.933 0 0 1 3.619-.687c.17-.028.34-.053.509-.078.215-.033.43-.066.644-.096l.205-.03zm1.18.003V22.96a61.042 61.042 0 0 1 12.333-.213V1.485A60.859 60.859 0 0 0 8.912.003zm1.707 1.81a.59.59 0 0 1 .015 0c3.06.088 6.125.404 9.167.95a.59.59 0 0 1 .476.686.59.59 0 0 1-.569.484.59.59 0 0 1-.116-.009 60.622 60.622 0 0 0-8.992-.931.59.59 0 0 1-.573-.607.59.59 0 0 1 .592-.572zm-4.212.028a.59.59 0 0 1 .578.565.59.59 0 0 1-.564.614 59.74 59.74 0 0 0-2.355.144.59.59 0 0 1-.04.002.59.59 0 0 1-.595-.542.59.59 0 0 1 .54-.635c.8-.065 1.6-.114 2.401-.148a.59.59 0 0 1 .035 0zm4.202 2.834a.59.59 0 0 1 .015 0 61.6 61.6 0 0 1 9.167.8.59.59 0 0 1 .488.677.59.59 0 0 1-.602.494.59.59 0 0 1-.076-.006 60.376 60.376 0 0 0-8.99-.786.59.59 0 0 1-.584-.596.59.59 0 0 1 .582-.583zm-4.211.097a.59.59 0 0 1 .587.555.59.59 0 0 1-.554.622c-.786.046-1.572.107-2.356.184a.59.59 0 0 1-.04.003.59.59 0 0 1-.603-.533.59.59 0 0 1 .53-.644c.8-.078 1.599-.14 2.4-.187a.59.59 0 0 1 .036 0zM10.6 7.535a.59.59 0 0 1 .015 0c3.06-.013 6.125.204 9.167.65a.59.59 0 0 1 .498.67.59.59 0 0 1-.593.504.59.59 0 0 1-.076-.006 60.142 60.142 0 0 0-8.992-.638.59.59 0 0 1-.592-.588.59.59 0 0 1 .573-.592zm1.153 2.846a61.093 61.093 0 0 1 8.02.515.59.59 0 0 1 .509.66.59.59 0 0 1-.586.514.59.59 0 0 1-.076-.005 59.982 59.982 0 0 0-8.99-.492.59.59 0 0 1-.603-.577.59.59 0 0 1 .578-.603c.382-.008.765-.012 1.148-.012zm1.139 2.832a60.92 60.92 0 0 1 6.871.394.59.59 0 0 1 .52.652.59.59 0 0 1-.577.523.59.59 0 0 1-.076-.004 59.936 59.936 0 0 0-8.991-.344.59.59 0 0 1-.61-.568.59.59 0 0 1 .567-.611c.765-.028 1.53-.042 2.296-.042z"></path>
+            </svg>
+            """,  # noqa: E501
+            "class": "",
+        },
     ],
-    "show_prev_next": False,
-    "use_edit_page_button": False,
-    "navbar_start": ["navbar-logo"],
-    "navbar_center": ["navbar-nav"],
-    "navbar_end": ["navbar-icon-links"],
-}
-html_logo = "images/aeon-logo-text-horizontal.png"
-html_context = {
-    "github_user": "aeon-toolkit",
-    "github_repo": "aeon",
-    "github_version": "main",
-    "doc_path": "docs/source/",
 }
+
+html_logo = "images/aeon-logo-horizontal.png"
 html_favicon = "images/aeon-favicon.ico"
-html_sidebars = {
-    "**": ["search-field.html", "sidebar-nav-bs.html", "sidebar-ethical-ads.html"]
-}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -254,16 +275,6 @@ def find_source():
     "js/dynamic_table.js",
 ]
 
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# The default sidebars (for documents that don't match any pattern) are
-# defined by theme itself.  Builtin themes are using these templates by
-# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
-# 'searchbox.html']``.
-#
-# html_sidebars = {}
-
 html_show_sourcelink = False
 
 # -- Options for HTMLHelp output ---------------------------------------------
@@ -418,7 +429,7 @@ def adds(pth):
 current_file = "{{ env.doc2path( env.docname, base=None) }}"
 
 # make sure Binder points to latest stable release, not main
-binder_url = f"https://mybinder.org/v2/gh/aeon-toolkit/aeon/{CURRENT_VERSION}?filepath={current_file}"  # noqa
+binder_url = f"https://mybinder.org/v2/gh/aeon-toolkit/aeon/{github_tag}?filepath={current_file}"  # noqa
 nbsphinx_prolog = f"""
 .. |binder| image:: https://mybinder.org/badge_logo.svg
 .. _Binder: {binder_url}
@@ -427,7 +438,7 @@ def adds(pth):
 """
 
 # add link to original notebook at the bottom
-notebook_url = f"https://github.com/aeon-toolkit/aeon/tree/{CURRENT_VERSION}/{current_file}"  # noqa
+notebook_url = f"https://github.com/aeon-toolkit/aeon/tree/{github_tag}/{current_file}"
 nbsphinx_epilog = f"""
 ----
 

diff --git a/docs/source/images/aeon-favicon.ico b/docs/source/images/aeon-favicon.ico
diff --git a/docs/source/images/aeon-logo-horizontal.png b/docs/source/images/aeon-logo-horizontal.png
diff --git a/docs/source/images/aeon-logo-no-text-vertical.png b/docs/source/images/aeon-logo-no-text-vertical.png
diff --git a/docs/source/images/aeon-logo-no-text.jpg b/docs/source/images/aeon-logo-no-text.jpg
diff --git a/docs/source/images/aeon-logo-no-text.png b/docs/source/images/aeon-logo-no-text.png
diff --git a/docs/source/images/aeon-logo-text-horizontal.png b/docs/source/images/aeon-logo-text-horizontal.png
diff --git a/docs/source/images/aeon-logo.jpg b/docs/source/images/aeon-logo.jpg
diff --git a/docs/source/images/aeon-logo.png b/docs/source/images/aeon-logo.png
diff --git a/docs/source/images/gsoc.png b/docs/source/images/gsoc.png
diff --git a/docs/source/images/numfocus.png b/docs/source/images/numfocus.png
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -0,0 +1,151 @@
+# Welcome to the documentation for **aeon**
+
+<br>
+
+- Framework for time series tasks such as forecasting and classification.
+- Extends the scikit-learn interface, allowing for ease of use for familiar users.
+- Efficient implementation of time series algorithms using numba.
+- Interfaces with other time series packages to provide a single framework for algorithm comparison.
+- Uses a system of optional dependencies to allow easy installation of basic functionality.
+
+<br>
+
+::::{grid} 1 2 2 2
+:gutter: 3
+
+:::{grid-item-card}
+:img-top: examples/img/forecasting2.png
+:text-align: center
+
+Forecasting
+
+^^^
+
+Get started with time series forecasting.
+
++++
+
+```{button-ref} get_started
+:color: primary
+:click-parent:
+:expand:
+
+Forecasting
+```
+
+:::
+
+:::{grid-item-card}
+:img-top: examples/img/tsc.png
+:text-align: center
+
+Classification
+
+^^^
+
+Get started with time series classification.
+
++++
+
+```{button-ref} users
+:color: primary
+:click-parent:
+:expand:
+
+Classification
+```
+
+:::
+
+:::{grid-item-card}
+:img-top: examples/img/tser.png
+:text-align: center
+
+Regression
+
+^^^
+
+Get started with time series extrinsic regression.
+
++++
+
+```{button-ref} installation
+:color: primary
+:click-parent:
+:expand:
+
+Regression
+```
+
+:::
+
+:::{grid-item-card}
+:img-top: examples/img/tscl.png
+:text-align: center
+
+Clustering
+
+^^^
+
+Get started with time series clustering.
+
++++
+
+```{button-ref} api_reference
+:color: primary
+:click-parent:
+:expand:
+
+Clustering
+```
+
+:::
+
+:::{grid-item-card}
+:img-top: examples/img/transformation.png
+:text-align: center
+
+Transformations
+
+^^^
+
+Get started with time series transformations.
+
++++
+
+```{button-ref} get_involved
+:color: primary
+:click-parent:
+:expand:
+
+Transformations
+```
+
+:::
+
+::::
+
+## Community Channels
+
+**GitHub**: [github.com/aeon-toolkit/aeon](https://github.com/aeon-toolkit/aeon)
+
+**Slack**: [aeon Slack](https://join.slack.com/t/aeon-toolkit/shared_invite/zt-1plkevy4x-vAg1dAUXcuoR38FjY9nxzg)
+
+**Twitter**: link
+
+**LinkedIn**: [linkedin/aeon-toolkit](https://www.linkedin.com/company/aeon-toolkit)
+
+
+```{toctree}
+:maxdepth: 1
+:hidden:
+
+installation
+get_started
+api_reference
+examples
+get_involved
+users
+developers
+about
+```