Merge pull request #61 from QuLogic/light-logo

Make logo names consistent

Author: jklymak

README.rst

@@ -19,17 +19,16 @@ installation.
 
 See the ``docs/conf.py`` file for other settings.
 
-There are three main templates that replace the defaults in ``pydata-sphinx-theme``:
+There are two main templates that replace the defaults in ``pydata-sphinx-theme``:
 
 .. code-block::
 
-   navbar_start = mpl_navbar_logo.html
    navbar_center = mpl_nav_bar.html
    navbar_end = mpl_icon_links.html
 
-Note that the option ``html_logo`` need not be specified as it is included
-in ``mpl_sphinx_theme/mpl_navbar_logo.html``.  The logo is stored at
-``mpl_sphinx_theme/static/images/logo2.svg``.
+Note that the logo options need not be specified as they are included in theme
+initialization. The logo is stored at
+``mpl_sphinx_theme/static/logo_{light,dark}.svg``.
 
 To change the top navbar, edit ``mpl_sphinx_theme/mpl_nav_bar.html``
 

docs/conf.py

@@ -46,7 +46,7 @@
 html_theme_options = {
     # logo is installed by mpl-sphinx-theme as:
     # "logo": {"link": "https://matplotlib.org/stable/",
-    #         "image_light": "_static/logo2.svg",
+    #         "image_light": "_static/logo_light.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

docs/index.rst

@@ -20,17 +20,16 @@ line in your conf.py file
 And by including ``mpl_sphinx_theme`` as a requirement in your documentation
 installation.
 
-There are three main templates that replace the defaults in ``pydata-sphinx-theme``:
+There are two main templates that replace the defaults in ``pydata-sphinx-theme``:
 
 .. code-block::
 
-   navbar_start = mpl_navbar_logo.html
    navbar_center = mpl_nav_bar.html
    navbar_end = mpl_icon_links.html
 
-Note that the option ``html_logo`` need not be specified as it is included
-in ``mpl_sphinx_theme/mpl_navbar_logo.html``.  The logo is stored at
-``mpl_sphinx_theme/static/images/logo2.svg``.
+Note that the logo options need not be specified as they are included in theme
+initialization. The logo is stored at
+``mpl_sphinx_theme/static/logo_{light,dark}.svg``.
 
 To change the top navbar, edit ``mpl_sphinx_theme/mpl_nav_bar.html``
 
@@ -77,4 +76,4 @@ Configuration for this demo
 
 The full ``conf.py`` is
 
-.. literalinclude:: conf.py
+.. literalinclude:: conf.py

mpl_sphinx_theme/__init__.py

@@ -4,7 +4,7 @@
 
 
 def set_config_defaults(app):
-
+    """Set default logo in theme options."""
     try:
         theme = app.builder.theme_options
     except AttributeError:
@@ -17,7 +17,7 @@ def set_config_defaults(app):
     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"
+        logo["image_light"] = "_static/logo_light.svg"
     if "link" not in logo:
         logo["link"] = "https://matplotlib.org/stable/"
     theme["logo"] = logo

mpl_sphinx_theme/mpl_navbar_logo.html

@@ -4,7 +4,6 @@ stylesheet = css/style.css
 
 [options]
 navbar_links = absolute
-# navbar_start = mpl_navbar_logo.html
 navbar_center = mpl_nav_bar.html
 navbar_end = theme-switcher.html, mpl_icon_links.html
-logo = images/logo2.svg
+logo = logo_light.svg