Add version switcher, favicon, and context-dependent logo (#586)

* Add version switcher, favicon, and context-dependent logo

* Update custom.css

* Update logo.png

* Response to review

* slim down navbar

* Update custom.css

* Update docs/source/conf.py

Co-authored-by: Maxime Lucas <[email protected]>

---------

Co-authored-by: Maxime Lucas <[email protected]>

docs/source/_static/custom.css

@@ -52,5 +52,14 @@ html[data-theme="light"] table.data tbody tr:nth-child(odd) {
 }
 
 html[data-theme="light"] table.data tbody tr:nth-child(even) {
-    background-color: #f2f2f2; /* Lighter gray */
+    background-color: #ffffff; /* Lighter gray */
+}
+
+/* Fixed width for the navbar items */
+.bd-header ul.navbar-nav {
+    width: 475px;
+}
+/* Remove whitespace to the right of the xgi logo */
+.bd-header .navbar-header-items__start {
+    width: 100px;
 }

docs/source/conf.py

@@ -13,17 +13,19 @@
 
 import os
 import sys
+from datetime import date, datetime
+
+import requests
 
 sys.path.insert(0, os.path.abspath("."))
 sys.path.append(os.path.join(os.path.dirname(__name__), "xgi"))
 
 
 # -- Project information -----------------------------------------------------
 project = "XGI"
-copyright = "2021-2024 XGI Developers"
+copyright = f"2021-{date.today().year} XGI Developers"
 release = "0.8.10"
 version = release
-today = "02-09-2024"
 
 # -- General configuration ---------------------------------------------------
 
@@ -65,9 +67,9 @@
 html_static_path = ["_static"]
 html_css_files = ["custom.css"]
 html_js_files = ["table.js"]
-
+html_favicon = "_static/x.ico"
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = "1.3"
+needs_sphinx = "6.2.1"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -88,6 +90,7 @@
     "nbsphinx_link",
 ]
 
+
 # Automatically generate stub pages when using the .. autosummary directive
 autosummary_generate = True
 autosummary_generate_overwrite = False
@@ -115,9 +118,18 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-# today = ''
+r = requests.get("https://api.github.com/repos/xgi-org/xgi/releases/latest")
+
+if r.ok:
+    release_date = (
+        datetime.fromisoformat(r.json()["published_at"]).date().strftime("%b %d, %Y")
+    )
+else:
+    raise Exception(f"Error: HTTP response {r.status_code}")
+
+today = release_date
 # Else, today_fmt is used as the format for a strftime call.
-today_fmt = "%B %d, %Y"
+# today_fmt = "%B %d, %Y"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -163,10 +175,15 @@
 
 # documentation.
 html_theme_options = {
+    "logo": {
+        "image_light": "../../logo/logo.svg",
+        "image_dark": "../../logo/logo_white.svg",
+    },
     "navbar_end": [
         "theme-switcher",
         "navbar-icon-links",
-    ],  # Place the social links at the end of the navbar
+        "version-switcher",
+    ],
     "icon_links": [
         {
             "name": "GitHub",
@@ -184,6 +201,13 @@
             "icon": "fa-brands fa-mastodon",  # Font Awesome icon
         },
     ],
+    "header_links_before_dropdown": 4,
+    "switcher": {
+        "json_url": (
+            "https://xgi.readthedocs.io/en/latest/_static/version_switcher.json"
+        ),
+        "version_match": "latest" if "dev" in version else version,
+    },
 }
 
 
@@ -201,9 +225,7 @@
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = ["_static"]
-# html_static_path = ["_static"]
-
-html_logo = "../../logo/logo.svg"
+html_static_path = ["_static"]
 
 html_show_sphinx = True
 

docs/source/index.rst

@@ -1,5 +1,10 @@
 
-.. image:: ../../logo/logo.svg
+.. image:: ../../logo/logo.png
+  :class: only-light
+  :width: 200
+
+.. image:: ../../logo/logo_white.png
+  :class: only-dark
   :width: 200
 
 .. toctree::
@@ -10,9 +15,9 @@
    user_guides
    api_reference
    xgi-data
-   gallery
    contribute
    using-xgi
+   gallery
 
 
 .. button-link:: https://github.com/xgi-org/xgi/releases/tag/v0.8.10