Merge pull request #58 from jklymak/enh-default-logo-loc

ENH: default logo loc

Author: QuLogic

docs/conf.py

@@ -44,9 +44,11 @@
 html_theme = "mpl_sphinx_theme"
 html_favicon = "_static/favicon.ico"
 html_theme_options = {
-    "logo": {"link": "https://matplotlib.org/stable/",
-             "image_light": "images/logo2.svg",
-             "image_dark": "images/logo_dark.svg"},
+    # logo is installed by mpl-sphinx-theme as:
+    # "logo": {"link": "https://matplotlib.org/stable/",
+    #         "image_light": "_static/logo2.svg",
+    #         "image_dark": "_static/logo_dark.svg"},
+    # if this default is OK, then no need to modify "logo"
     # collapse_navigation in pydata-sphinx-theme is slow, so skipped for local
     # and CI builds https://github.com/pydata/pydata-sphinx-theme/pull/386
     "collapse_navigation": not is_release_build,
@@ -62,4 +64,4 @@
 # 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_static_path = ["_static"]

docs/requirements.txt

@@ -1,2 +1,2 @@
-pydata-sphinx-theme>=0.10.0
+pydata-sphinx-theme>=0.13.1
 matplotlib

mpl_sphinx_theme/__init__.py

@@ -3,6 +3,29 @@
 from pathlib import Path
 
 
+def set_config_defaults(app):
+
+    try:
+        theme = app.builder.theme_options
+    except AttributeError:
+        theme = None
+    if not theme:
+        theme = {}
+
+    # Default logo
+    logo = theme.get("logo", {})
+    if "image_dark" not in logo:
+        logo["image_dark"] = "_static/logo_dark.svg"
+    if "image_light" not in logo:
+        logo["image_light"] = "_static/logo2.svg"
+    if "link" not in logo:
+        logo["link"] = "https://matplotlib.org/stable/"
+    theme["logo"] = logo
+
+    # Update the HTML theme config
+    app.builder.theme_options = theme
+
+
 def get_html_theme_path():
     """Return list of HTML theme paths."""
     return [str(Path(__file__).parent.parent.resolve())]
@@ -34,7 +57,7 @@ def setup(app):
     here = Path(__file__).parent.resolve()
     # Include component templates
     app.config.templates_path.append(str(here / "components"))
-
     app.add_html_theme("mpl_sphinx_theme", str(here))
+    app.connect("builder-inited", set_config_defaults)
     app.connect("html-page-context", setup_html_page_context)
     return {'version': __version__, 'parallel_read_safe': True}

mpl_sphinx_theme/static/images/logo2.svg renamed to mpl_sphinx_theme/static/logo2.svg

@@ -1,2 +1,2 @@
-pydata-sphinx-theme>=0.11.0
+pydata-sphinx-theme>=0.13.1
 matplotlib