Merge branch 'main' into readme

sktime · Sep 13, 2023 · 9fb5430 · 9fb5430
2 parents 15bc600 + da21f8d
commit 9fb5430
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 88 deletions.
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -1,3 +1,51 @@
-.. _top_level_changelog:
+=========
+Changelog
+=========
 
-.. include:: user_documentation/changelog.rst
+All notable changes to this project beggining with version 0.1.0 will be
+documented in this file. The format is based on
+`Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_ and we adhere
+to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_. The source
+code for all `releases <https://github.com/sktime/skbase/releases>`_
+is available on GitHub.
+
+You can also subscribe to ``skpro``'s
+`PyPi release <https://libraries.io/pypi/skpro>`_.
+
+For planned changes and upcoming releases, see our :ref:`roadmap`.
+
+[2.0.0] - 2023-09-1X
+====================
+
+Re-release of ``skpro``, newly rearchitected using ``skbase``.
+
+Highlights
+----------
+
+Enhancements
+------------
+
+Fixes
+-----
+
+Documentation
+-------------
+
+Maintenance
+-----------
+
+Contributors
+------------
+:user:`Alex-JG3`,
+:user:`fkiraly`,
+:user:`frthjf`
+
+[1.0.1] - 2019-02-18
+====================
+
+First stable release of ``skpro``, last release before hiatus.
+
+[1.0.0b] - 2017-12-08
+=====================
+
+First public release (beta) of ``skpro``.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -164,10 +164,6 @@ def find_source():
         version_match = "v" + release
 
 html_theme_options = {
-    "logo": {
-        "text": "skpro",
-        "alt_text": "skpro",
-    },
     "icon_links": [
         {
             "name": "GitHub",

diff --git a/docs/source/get_started.rst b/docs/source/get_started.rst
@@ -17,6 +17,6 @@ Installation
 * operating systems Mac OS X, Unix-like OS, Windows 8.1 and higher
 * installation via ``PyPi`` or ``conda``
 
-Please see the :ref:`installation <installation>` guide for step-by-step instructions on the package installation.
+Please see the :ref:`installation <full_install>` guide for step-by-step instructions on the package installation.
 
 .. _scikit-learn: https://scikit-learn.org/stable/index.html
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -33,13 +33,13 @@ code snippets below.
 
         .. code-block:: bash
 
-           pip install scikit-base
+           pip install skpro
 
     .. tab-item:: PyPi (all dependencies)
 
         .. code-block:: bash
 
-           pip install scikit-base[all_extras]
+           pip install skpro[all_extras]
 
     .. tab-item:: Conda
 

diff --git a/...e/user_documentation/related_software.rst → docs/source/related_software.rst b/...e/user_documentation/related_software.rst → docs/source/related_software.rst
diff --git a/docs/source/user_documentation/tutorials.rst → docs/source/tutorials.rst b/docs/source/user_documentation/tutorials.rst → docs/source/tutorials.rst
diff --git a/docs/source/user_documentation/changelog.rst b/docs/source/user_documentation/changelog.rst
diff --git a/.../source/user_documentation/user_guide.rst → docs/source/user_guide.rst b/.../source/user_documentation/user_guide.rst → docs/source/user_guide.rst
diff --git a/docs/source/users.rst b/docs/source/users.rst
@@ -8,12 +8,11 @@ Documentation
    :maxdepth: 1
    :hidden:
 
-   user_documentation/installation
-   user_documentation/tutorials
-   user_documentation/user_guide
-   user_documentation/glossary
-   user_documentation/changelog
-   user_documentation/related_software
+   installation
+   tutorials
+   user_guide
+   changelog
+   related_software
 
 
 .. grid:: 1 2 2 2
@@ -22,11 +21,11 @@ Documentation
     .. grid-item-card:: Installation
         :text-align: center
 
-        Install ``skbase``.
+        Install ``skpro``.
 
         +++
 
-        .. button-ref:: user_documentation/installation
+        .. button-ref:: installation
             :color: primary
             :click-parent:
             :expand:
@@ -40,7 +39,7 @@ Documentation
 
         +++
 
-        .. button-ref:: user_documentation/tutorials
+        .. button-ref:: tutorials
             :color: primary
             :click-parent:
             :expand:
@@ -50,39 +49,25 @@ Documentation
     .. grid-item-card:: User Guide
         :text-align: center
 
-        Learn about using ``skbase``.
+        Learn about using ``skpro``.
 
         +++
 
-        .. button-ref:: user_documentation/user_guide
+        .. button-ref:: user_guide
             :color: primary
             :click-parent:
             :expand:
 
             User Guide
 
-    .. grid-item-card:: Glossary
-        :text-align: center
-
-        Understand common terminology.
-
-        +++
-
-        .. button-ref:: user_documentation/glossary
-            :color: primary
-            :click-parent:
-            :expand:
-
-            Glossary
-
     .. grid-item-card:: Changelog
         :text-align: center
 
         Information for developers.
 
         +++
 
-        .. button-ref:: user_documentation/changelog
+        .. button-ref:: changelog
             :color: primary
             :click-parent:
             :expand:
@@ -92,11 +77,11 @@ Documentation
     .. grid-item-card:: Related Software
         :text-align: center
 
-        Explore software related to ``skbase``.
+        Explore software related to ``skpro``.
 
         +++
 
-        .. button-ref:: user_documentation/related_software
+        .. button-ref:: related_software
             :color: primary
             :click-parent:
             :expand: