diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index f6cf854a3..5bf93418b 100644 --- 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 `_ and we adhere +to `Semantic Versioning `_. The source +code for all `releases `_ +is available on GitHub. + +You can also subscribe to ``skpro``'s +`PyPi release `_. + +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 index 76042e2c8..a8fab2b4f 100644 --- 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 index 2ed70d138..a887a3efe 100644 --- 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 ` guide for step-by-step instructions on the package installation. +Please see the :ref:`installation ` 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 index c5b785ad6..4902b415e 100644 --- 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/docs/source/user_documentation/related_software.rst b/docs/source/related_software.rst similarity index 100% rename from docs/source/user_documentation/related_software.rst rename to docs/source/related_software.rst diff --git a/docs/source/user_documentation/tutorials.rst b/docs/source/tutorials.rst similarity index 100% rename from docs/source/user_documentation/tutorials.rst rename to docs/source/tutorials.rst diff --git a/docs/source/user_documentation/changelog.rst b/docs/source/user_documentation/changelog.rst deleted file mode 100644 index 5bf93418b..000000000 --- a/docs/source/user_documentation/changelog.rst +++ /dev/null @@ -1,51 +0,0 @@ -========= -Changelog -========= - -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 `_ and we adhere -to `Semantic Versioning `_. The source -code for all `releases `_ -is available on GitHub. - -You can also subscribe to ``skpro``'s -`PyPi release `_. - -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/user_documentation/user_guide.rst b/docs/source/user_guide.rst similarity index 100% rename from docs/source/user_documentation/user_guide.rst rename to docs/source/user_guide.rst diff --git a/docs/source/users.rst b/docs/source/users.rst index d0989b24c..8ce06235d 100644 --- 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,31 +49,17 @@ 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 @@ -82,7 +67,7 @@ Documentation +++ - .. 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: