ENH: remove the need to specify the icon links

jklymak · jklymak · commit 1e85e51fd8a8 · 2021-10-18T16:15:21.000+02:00
diff --git a/docs/Makefile b/docs/Makefile
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?= "-vv"
+SPHINXOPTS    ?= "-vvv"
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,35 +28,12 @@
 # -- Options for HTML output -------------------------------------------------
 
 html_theme = "mpl_sphinx_theme"
-html_logo = "_static/logo2.svg"
 html_favicon = "_static/favicon.ico"
 html_theme_options = {
     "logo_link": "https://matplotlib.org/stable/",
     # 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,
-    "icon_links": [
-        {
-            "name": "gitter",
-            "url": "https://gitter.im/matplotlib",
-            "icon": "fab fa-gitter",
-        },
-        {
-            "name": "discourse",
-            "url": "https://discourse.matplotlib.org",
-            "icon": "fab fa-discourse",
-        },
-        {
-            "name": "GitHub",
-            "url": "https://github.com/matplotlib/matplotlib",
-            "icon": "fab fa-github-square",
-        },
-        {
-            "name": "twitter",
-            "url": "https://twitter.com/matplotlib/",
-            "icon": "fab fa-twitter-square",
-        },
-    ],
     "show_prev_next": False,
     "navbar_center": ["mpl_nav_bar.html"],
     "native_site": False
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,9 +19,10 @@ line in your conf.py file
 And by including ``mpl_sphinx_theme`` as a requirement in your documentation
 installation.
 
-Note that the theme does not currently install the `logo2.svg` or 
-the `favicon.ico`.  You shoudl copy those from `docs/_static` to 
-the local project `docs/_static`. 
+Note that the option ``html_logo`` need not be specified as it is for 
+``pydata-sphinx-theme``.
+
+To change the top navbar, edit ``mpl_sphinx_theme/mpl_nav_bar.html``
 
 The full ``conf.py`` is 
 
diff --git a/mpl_sphinx_theme/icon-links.html b/mpl_sphinx_theme/icon-links.html
@@ -0,0 +1,50 @@
+{%- macro icon_link_nav_item(url, icon, name) -%}
+  {%- if url | length > 2 %}
+        <li class="nav-item">
+          <a class="nav-link" href="{{ url }}" rel="noopener" target="_blank" title="{{ _(name) }}">
+            <span><i class="{{ icon }}"></i></span>
+            <label class="sr-only">{{ _(name) }}</label>
+          </a>
+        </li>
+  {%- endif -%}
+{%- endmacro -%}
+{%- if theme_icon_links %}  
+      <ul id="navbar-icon-links" class="navbar-nav" aria-label="{{ _(theme_icon_links_label) }}">
+        {%- block icon_link_shortcuts -%}
+        {{ icon_link_nav_item(theme_github_url, "fab fa-github-square", "GitHub") -}}
+        {{ icon_link_nav_item(theme_gitlab_url, "fab fa-gitlab", "GitLab") -}}
+        {{ icon_link_nav_item(theme_bitbucket_url, "fab fa-bitbucket", "Bitbucket") -}}
+        {{ icon_link_nav_item(theme_twitter_url, "fab fa-twitter-square", "Twitter") -}}
+        {% endblock -%}
+        {%- for icon_link in theme_icon_links -%}
+        {{ icon_link_nav_item(icon_link["url"], icon_link["icon"], icon_link["name"]) -}}
+        {%- endfor %}
+      </ul>
+{%- else %}
+      <ul id="navbar-icon-links" class="navbar-nav" aria-label="{{ _(theme_icon_links_label) }}">
+        <li class="nav-item">
+          <a class="nav-link" href="https://gitter.im/matplotlib" rel="noopener" target="_blank" title="gitter">
+            <span><i class="fab fa-gitter"></i></span>
+            <label class="sr-only">gitter</label>
+          </a>
+        </li>
+        <li class="nav-item">
+          <a class="nav-link" href="https://discourse.matplotlib.org" rel="noopener" target="_blank" title="discourse">
+            <span><i class="fab fa-discourse"></i></span>
+            <label class="sr-only">discourse</label>
+          </a>
+        </li>
+        <li class="nav-item">
+          <a class="nav-link" href="https://github.com/matplotlib/matplotlib" rel="noopener" target="_blank" title="GitHub">
+            <span><i class="fab fa-github-square"></i></span>
+            <label class="sr-only">GitHub</label>
+          </a>
+        </li>
+        <li class="nav-item">
+          <a class="nav-link" href="https://twitter.com/matplotlib/" rel="noopener" target="_blank" title="twitter">
+            <span><i class="fab fa-twitter-square"></i></span>
+            <label class="sr-only">twitter</label>
+          </a>
+        </li>
+      </ul>
+{%- endif %}  
diff --git a/mpl_sphinx_theme/static/images/background.png b/mpl_sphinx_theme/static/images/background.png
diff --git a/mpl_sphinx_theme/static/images/dask-horizontal-white.svg b/mpl_sphinx_theme/static/images/dask-horizontal-white.svg
diff --git a/mpl_sphinx_theme/theme.conf b/mpl_sphinx_theme/theme.conf
@@ -3,4 +3,5 @@ inherit = pydata_sphinx_theme
 stylesheet = css/style.css
 
 [options]
-native_site = False
+native_site = False
+navbar_start = mpl_navbar_logo.html
