docs: Put Comet logo in top nav bar, respect light/dark mode (#2591)

Author: andygrove

docs/source/_static/theme_overrides.css

@@ -33,6 +33,14 @@
   --pst-font-size-base: 0.9rem;
 }
 
+/* Scale down the logo in the top navbar */
+.bd-header .navbar-brand img.logo__image {
+  height: 40px;
+  width: auto;
+  margin-right: 0.25rem;
+  vertical-align: middle;
+}
+
 /* --- remove the right (secondary) sidebar entirely --- */
 .bd-sidebar-secondary { display: none !important; }
 

docs/source/_templates/docs-sidebar.html

@@ -21,9 +21,5 @@
   <div class="bd-toc-item active">
     {{ toctree(maxdepth=4, collapse=True, includehidden=True, titles_only=True) }}
   </div>
-
-  <a class="navbar-brand" href="{{ pathto(master_doc) }}">
-    <img src="{{ pathto('_static/images/DataFusionComet-Logo-Light.png', 1) }}" class="logo" alt="logo">
-  </a>
 </nav>
 

docs/source/conf.py

@@ -85,11 +85,18 @@
 #
 html_theme = 'pydata_sphinx_theme'
 
+html_logo = "_static/images/DataFusionComet-Logo-Light.png"
+
 html_theme_options = {
+    "logo": {
+        "image_light": "_static/images/DataFusionComet-Logo-Light.png",
+        "image_dark": "_static/images/DataFusionComet-Logo-Dark.png",
+    },
+
     "use_edit_page_button": False,
     "secondary_sidebar_items": [],
     "collapse_navigation": True,
-    "navbar_start": [],
+    "navbar_start": ["navbar-logo"],
     "navbar_center": ["navbar-nav"],
     "navbar_end": ["navbar-icon-links", "theme-switcher"],
     "icon_links": [
@@ -115,8 +122,6 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-html_logo = "_static/images/DataFusionComet-Logo-Light.png"
-
 html_css_files = [
     "theme_overrides.css"
 ]

docs/source/index.rst

@@ -15,9 +15,6 @@
 .. specific language governing permissions and limitations
 .. under the License.
 
-.. image:: _static/images/DataFusionComet-Logo-Light.png
-  :alt: DataFusion Comet Logo
-
 =======================
 Apache DataFusion Comet
 =======================