Big Update

README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-<img src="docs/source/cca-zoo-logo.jpg" alt="drawing" width="200"/>
+<img src="docs/source/_static/cca-zoo-logo.svg" alt="drawing" width="200"/>
 
 # CCA-Zoo
 

docs/source/_static/site.webmanifest

@@ -0,0 +1 @@
+{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}

docs/source/conf.py

@@ -27,10 +27,11 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx_gallery.gen_gallery",
+    "sphinx_favicon",
 ]
 
 templates_path = ["_templates"]
-exclude_patterns = ["_build", "_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
@@ -60,56 +61,50 @@
     "members": True,
     "show-inheritance": True,
     "member-order": "bysource",
-    "inherited-members": True,
-    "autodoc_mock_imports": ["torch" "sklearn", "lightning", "jax", "jaxlib"],
 }
 
 # generate autosummary even if no references
 autosummary_generate = True
 
 # -- 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"
+html_logo = "_static/cca-zoo-logo.svg"
+html_favicon = "_static/cca-zoo-logo.svg"
+html_sourcelink_suffix = ""
+html_last_updated_fmt = ""  # to reveal the build date in the pages meta
 
-# 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 = {
-    "show_nav_level": 1,
+    "header_links_before_dropdown": 4,
     "icon_links": [
         {
-            # Label for this link
             "name": "GitHub",
-            # URL where the link will redirect
-            "url": "https://github.com/jameschapman19/proxtorch",  # required
-            # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
-            "icon": "fa-brands fa-square-github",
-            # The type of image to be used (see below for details)
-            "type": "fontawesome",
-        }
+            "url": "https://github.com/jameschapman19/cca_zoo",
+            "icon": "fa-brands fa-github",
+        },
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/cca-zoo/",
+            "icon": "fa-custom fa-pypi",
+        },
     ],
+    "logo": {
+        "text": "CCA-Zoo",
+        "image": "_static/cca-zoo-logo.svg",
+    },
     "use_edit_page_button": True,
+    "show_toc_level": 1,
+    "navbar_align": "left",
+    "navbar_center": ["navbar-nav"],
+    "footer_start": ["copyright"],
+    "footer_center": ["sphinx-version"],
+    "navigation_with_keys": False,
 }
 
+
 html_context = {
     "github_user": "jameschapman19",
-    "github_repo": "proxtorch",
+    "github_repo": "cca_zoo",
     "github_version": "main",
     "doc_path": "docs/source",
 }
-
-# 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_logo = "cca-zoo-logo.png"
-html_favicon = "favicon.ico"

docs/source/index.rst

@@ -5,12 +5,9 @@ Welcome to CCA-Zoo! 🚀
 --------------------------
 Dive into the world of CCA-Zoo! Unlock the hidden relationships in multiview data.
 
-Table of Contents
------------------
-
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: 📘 Using CCA-Zoo
 
    usage/introduction
@@ -33,7 +30,7 @@ Table of Contents
 
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: 🔧 Developer Information
 
    developer_info/contribute

docs/source/requirements.txt

@@ -1,8 +1,9 @@
 protobuf==3.20.1
 sphinx
-sphinx-autodoc-typehints
 sphinx-gallery
+sphinx-favicon
 pydata_sphinx_theme
+myst-parser
 colorcet
 seaborn
 pandas

docs/source/usage/introduction.rst

@@ -1,5 +1,5 @@
-CCA-Zoo: Canonical Correlation Analysis in Python
-===================================================================
+Introduction to CCA
+=======================
 
 Welcome to CCA-Zoo, a one-stop repository for state-of-the-art Canonical Correlation Analysis (CCA) algorithms. Over the years, a multitude of CCA extensions have emerged in the academic sphere. CCA-Zoo harnesses the power of modern computational techniques to facilitate the effortless application of these algorithms to real-world, multiview data scenarios.