Epistimio · bouthilx · Sep 2, 2022 · Sep 2, 2022 · Sep 2, 2022 · Sep 2, 2022
diff --git a/README.rst b/README.rst
@@ -1,6 +1,6 @@
-*****
-Oríon
-*****
+.. image:: _static/logo/orion_logo_grid_150ppi.png
+  :width: 400
+  :alt: Oríon
 
 |pypi| |py_versions| |license| |doi|
 |rtfd| |codecov| |github-actions|

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,8 +1,9 @@
-sphinx
+sphinx==4.5.0
 sphinx_rtd_theme
+pydata-sphinx-theme
 sphinxcontrib.httpdomain
 sphinx-autoapi
-sphinx_gallery
+sphinx_gallery==0.11.0
 numpydoc
 plotly
 matplotlib

diff --git a/docs/src/_static/logo/orion_logo.ai b/docs/src/_static/logo/orion_logo.ai
diff --git a/docs/src/_static/logo/orion_logo_bow_only_no_string.png b/docs/src/_static/logo/orion_logo_bow_only_no_string.png
diff --git a/docs/src/_static/logo/orion_logo_bow_only_no_string_on_black.png b/docs/src/_static/logo/orion_logo_bow_only_no_string_on_black.png
diff --git a/docs/src/_static/logo/orion_logo_grid_150ppi.png b/docs/src/_static/logo/orion_logo_grid_150ppi.png
diff --git a/docs/src/_static/logo/orion_logo_grid_300ppi.png b/docs/src/_static/logo/orion_logo_grid_300ppi.png
diff --git a/docs/src/_static/logo/orion_logo_grid_72ppi.png b/docs/src/_static/logo/orion_logo_grid_72ppi.png
diff --git a/docs/src/_static/logo/orion_logo_nogrid_150ppi.png b/docs/src/_static/logo/orion_logo_nogrid_150ppi.png
diff --git a/docs/src/_static/logo/orion_logo_nogrid_300ppi.png b/docs/src/_static/logo/orion_logo_nogrid_300ppi.png
diff --git a/docs/src/_static/logo/orion_logo_nogrid_72ppi.png b/docs/src/_static/logo/orion_logo_nogrid_72ppi.png
diff --git a/docs/src/code/index.rst b/docs/src/code/index.rst
@@ -0,0 +1,19 @@
+
+.. API Reference:
+
+*************
+API Reference
+*************
+
+.. toctree::
+   :maxdepth: 2
+
+   algo
+   analysis
+   benchmark
+   client
+   core
+   executor
+   plotting
+   storage
+   testing
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -115,43 +115,48 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
-html_theme_options = {
-    "canonical_url": "",
-    "analytics_id": "",
-    "logo_only": False,
-    "display_version": True,
-    "prev_next_buttons_location": "both",
-    #  'style_external_links': False,
-    #  'vcs_pageview_mode': '',
-    # Toc options
-    "collapse_navigation": False,
-    "sticky_navigation": True,
-    "navigation_depth": 4,
-    #  'includehidden': False,
-    #  'titles_only': False
-}
+html_theme = "pydata_sphinx_theme"
 
 # 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 = {}
+
+html_theme_options = {
+    # TODO: Add version for dark theme
+    # "logo": {
+    #     "image_light": "logo-light.png",
+    #     "image_dark": "logo-dark.png",
+    # },
+    "github_url": "https://github.com/Epistimio/orion",
+    "collapse_navigation": True,
+    "show_nav_level": 2,
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links.html"],
+    # "switcher": {  # TODO in another PR. We need the version json file
+    #     "version_match": "v0.2.4",
+    #     "json_url": "https://numpy.org/doc/_static/versions.json",  # TODO
+    # },
+    "left_sidebar_end": ["sidebar-ethical-ads"],
+}
 
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+html_favicon = "_static/logo/orion_logo_bow_only_no_string.png"
+html_logo = "_static/logo/orion_logo_nogrid_72ppi.png"
+
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
 # This is required for the alabaster theme
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 html_sidebars = {
     "**": [
-        "relations.html",  # needs 'show_related': True theme option to display
-        "searchbox.html",
+        "search-field",
+        "sidebar-nav-bs",
+        # "relations.html",  # needs 'show_related': True theme option to display
+        # "sidebar-ethical-ads.html",
     ]
 }
 
@@ -254,7 +259,7 @@
     "plotly": ("https://plotly.com/python-api-reference/", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
     "torch": ("https://pytorch.org/docs/stable/", None),
-    "pandas": ("https://pandas.pydata.org/docs/", None)
+    "pandas": ("https://pandas.pydata.org/docs/", None),
 }
 
 

diff --git a/docs/src/developer/overview.rst b/docs/src/developer/overview.rst
@@ -1,6 +1,19 @@
-********
-Overview
-********
+************
+Contributing
+************
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   .. overview
+   installing
+   standards
+   testing
+   documenting
+   ci
+   release
+
 
 Welcome to the project. We're excited you decided to improve Oríon!
 

diff --git a/docs/src/index.rst b/docs/src/index.rst
@@ -1,75 +1,23 @@
 .. include:: ../../README.rst
 
 .. toctree::
-   :caption: Welcome
    :maxdepth: 1
+   :hidden:
 
    install/gettingstarted
-   install/core
-   install/database
-..    contributors
-
-.. toctree::
-   :caption: User Guide
-   :maxdepth: 1
-
    user/overview
-   user/script
-   user/api
-   user/algorithms
-   user/searchspace
-   user/monitoring
-   auto_examples/index
-   user/benchmark
-   user/evc
-   user/storage
-   user/config
-   user/parallel
-
-.. toctree::
-   :caption: Tutorials
-   :maxdepth: 1
-
-   tutorials/scikit-learn
-   auto_tutorials/code_1_python_api
-   tutorials/pytorch-mnist
-   auto_tutorials/code_2_hyperband_checkpoint
-   auto_tutorials/code_4_parallelism
-   tutorials/cluster
-   tutorials/pytorch_a2c_ppo
-
-.. toctree::
-   :caption: Plugins
-   :maxdepth: 1
-
-   plugins/base
-   plugins/install
-   plugins/algorithms
-
-.. toctree::
-   :maxdepth: 2
-   :caption: API Reference
+   tutorials/index
+   code/index
+   developer/overview
 
-   code/algo
-   code/analysis
-   code/benchmark
-   code/client
-   code/core
-   code/executor
-   code/plotting
-   code/storage
-   code/testing
+.. .. toctree::
+..    :caption: Plugins
+..    :maxdepth: 1
+.. 
+..    plugins/base
+..    plugins/install
+..    plugins/algorithms
 
-.. toctree::
-   :caption: Developer Guide
-   :maxdepth: 1
 
-   developer/overview
-   developer/installing
-   developer/standards
-   developer/testing
-   developer/documenting
-   developer/ci
-   developer/release
 
 .. Don't fetch reference/viz
diff --git a/docs/src/install/gettingstarted.rst b/docs/src/install/gettingstarted.rst
@@ -2,6 +2,13 @@
 Getting Started
 ***************
 
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   core
+   database
+
 Welcome! In this chapter, we give a quick overview of Oríon's main features and how it can help you
 streamline your machine learning workflow whether you are a researcher or engineer.
 

diff --git a/docs/src/tutorials/code_1_python_api.rst b/docs/src/tutorials/code_1_python_api.rst
@@ -0,0 +1 @@
+.. include:: ../auto_tutorials/code_1_python_api.rst
diff --git a/docs/src/tutorials/code_2_hyperband_checkpoint.rst b/docs/src/tutorials/code_2_hyperband_checkpoint.rst
@@ -0,0 +1 @@
+.. include:: ../auto_tutorials/code_2_hyperband_checkpoint.rst
diff --git a/docs/src/tutorials/code_4_parallelism.rst b/docs/src/tutorials/code_4_parallelism.rst
@@ -0,0 +1 @@
+.. include:: ../auto_tutorials/code_4_parallelism.rst
diff --git a/docs/src/tutorials/index.rst b/docs/src/tutorials/index.rst
@@ -0,0 +1,16 @@
+.. _Tutorials:
+
+*********
+Tutorials
+*********
+
+.. toctree::
+   :maxdepth: 1
+
+   scikit-learn
+   code_1_python_api
+   pytorch-mnist
+   code_2_hyperband_checkpoint
+   code_4_parallelism
+   cluster
+   pytorch_a2c_ppo
diff --git a/docs/src/user/overview.rst b/docs/src/user/overview.rst
@@ -1,11 +1,29 @@
-********
-Overview
-********
+**********
+User Guide
+**********
 
 .. The goal of this document is to provide an overview of the content present in the user guide.
 .. It is not meant to replace the general getting started or duplicate the content in the user guide
 .. sections.
 
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   .. overview
+   script
+   api
+   algorithms
+   searchspace
+   monitoring
+   visualisations
+   benchmark
+   evc
+   storage
+   config
+   parallel
+
+
 In this guide, we explain the concepts of Oríon in depth. A light weight introduction is available
 in :doc:`/install/gettingstarted` to familiarize yourself with the project and its concepts.
 

diff --git a/setup.py b/setup.py
@@ -34,11 +34,12 @@
     "docs": [
         "matplotlib",
         "numpydoc",
-        "sphinx",
+        "sphinx==4.5.0",
         "sphinx_rtd_theme",
+        "pydata-sphinx-theme",
         "sphinxcontrib.httpdomain",
         "sphinx-autoapi",
-        "sphinx_gallery",
+        "sphinx_gallery==0.11.0",
     ],
     "dask": ["dask[complete]"],
     "track": ["track @ git+https://github.com/Delaunay/track@master#egg=track"],