From 9467b80db761b96d57c80f124d88b64f8e77a523 Mon Sep 17 00:00:00 2001
From: 12rambau <pierrick.rambaud49@gmail.com>
Date: Sun, 28 Aug 2022 12:08:24 +0200
Subject: [PATCH 1/7] add the alt_text option

---
 .../components/navbar-logo.html                    | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-logo.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-logo.html
index 7b5773e0c..70868c836 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-logo.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-logo.html
@@ -1,22 +1,24 @@
 {% if not theme_logo.get("link") %}
   {% set href = pathto(root_doc) %}
 {% elif theme_logo.get("link").startswith("http") %}
-  {# Logo link is to external URL #}
-  {% set href = theme_logo.get("link") %}
+  {% set href = theme_logo.get("link") %} {# external url #}
 {% else %}
-  {# Logo link is to internal page #}
-  {% set href = pathto(theme_logo.get("link")) %}
+  {% set href = pathto(theme_logo.get("link")) %} {# internal page #}
 {% endif %}
 
 <a class="navbar-brand logo" href="{{ href }}">
+
+  {# get all the brand information from html_theme_option #}
   {% set is_logo = logo or theme_logo.get("image_light") or theme_logo.get("image_dark") %}
   {% set image_light = theme_logo.get("image_light") or logo %}
   {% set image_dark = theme_logo.get("image_dark") or logo %}
   {% set image_light = image_light if image_light.startswith("http") else pathto('_static/' + image_light, 1) %}
   {% set image_dark = image_dark if image_dark.startswith("http") else pathto('_static/' + image_dark, 1) %}
+  {% set alt = theme_logo.get("alt_text", "Logo image") %}
+
   {% if is_logo %}
-    <img src="{{ image_light }}" class="logo__image only-light" alt="Logo image">
-    <img src="{{ image_dark }}" class="logo__image only-dark" alt="Logo image">
+    <img src="{{ image_light }}" class="logo__image only-light" alt="{{ alt }}">
+    <img src="{{ image_dark }}" class="logo__image only-dark" alt="{{ alt }}">
   {% endif %}
   {% if not is_logo or theme_logo.get("text") %}
     <p class="title logo__title">{{ theme_logo.get("text") or docstitle }}</p>

From dcb8beb4e87c73ecf29ab1706b2664247d065d17 Mon Sep 17 00:00:00 2001
From: 12rambau <pierrick.rambaud49@gmail.com>
Date: Sun, 28 Aug 2022 12:17:05 +0200
Subject: [PATCH 2/7] add the documentation

---
 docs/user_guide/branding.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/user_guide/branding.rst b/docs/user_guide/branding.rst
index 60e2e0f43..3ba1d678a 100644
--- a/docs/user_guide/branding.rst
+++ b/docs/user_guide/branding.rst
@@ -74,6 +74,22 @@ To reference an external website, make sure your link starts with ``http``:
        }
    }
 
+Customize logo alternative text
+-------------------------------
+
+The logo is by default using "Logo image" as an alternative text of the image. To set
+a specific alt text for this to be accessible to those using screen readers and another
+assistive tech, use the ``html_teme_options["logo"]["alt_text"]`` and provide a new name
+as in the following example:
+
+.. code-block:: python
+
+   html_theme_options = {
+       "logo": {
+           "alt_text": "foo",
+       }
+   }
+
 Add a logo title
 ----------------
 

From af1dbc5d19f2fe485d05647a426b13879e949987 Mon Sep 17 00:00:00 2001
From: 12rambau <pierrick.rambaud49@gmail.com>
Date: Sun, 28 Aug 2022 12:18:07 +0200
Subject: [PATCH 3/7] add alt text to our own documentation

---
 docs/conf.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/conf.py b/docs/conf.py
index a79e750b8..8f4561d96 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -129,6 +129,7 @@
     "logo": {
         "text": "PyData Theme",
         "image_dark": "logo-dark.svg",
+        "alt_text": "PyData Theme",
     },
     "use_edit_page_button": True,
     "show_toc_level": 1,

From 670684be3181ee50ff98a7bb4b2bdc0541a0a481 Mon Sep 17 00:00:00 2001
From: 12rambau <pierrick.rambaud49@gmail.com>
Date: Sun, 28 Aug 2022 12:26:51 +0200
Subject: [PATCH 4/7] typo

---
 docs/user_guide/branding.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/user_guide/branding.rst b/docs/user_guide/branding.rst
index 3ba1d678a..77e8cd04a 100644
--- a/docs/user_guide/branding.rst
+++ b/docs/user_guide/branding.rst
@@ -78,7 +78,7 @@ Customize logo alternative text
 -------------------------------
 
 The logo is by default using "Logo image" as an alternative text of the image. To set
-a specific alt text for this to be accessible to those using screen readers and another
+a specific alt text for this to be accessible to those using screen readers or other
 assistive tech, use the ``html_teme_options["logo"]["alt_text"]`` and provide a new name
 as in the following example:
 

From 9232f6a636271d9513db3fd399c3b6b4540a0367 Mon Sep 17 00:00:00 2001
From: Rambaud Pierrick <12rambau@users.noreply.github.com>
Date: Sun, 28 Aug 2022 14:12:26 +0200
Subject: [PATCH 5/7] use caption

Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
---
 docs/user_guide/branding.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/user_guide/branding.rst b/docs/user_guide/branding.rst
index 77e8cd04a..a0a8a4d1b 100644
--- a/docs/user_guide/branding.rst
+++ b/docs/user_guide/branding.rst
@@ -83,6 +83,7 @@ assistive tech, use the ``html_teme_options["logo"]["alt_text"]`` and provide a
 as in the following example:
 
 .. code-block:: python
+   :caption: conf.py
 
    html_theme_options = {
        "logo": {

From b7aeb2baddb45e1e42b0e68e69e5bb69d9963f48 Mon Sep 17 00:00:00 2001
From: Rambaud Pierrick <12rambau@users.noreply.github.com>
Date: Sun, 28 Aug 2022 14:22:11 +0200
Subject: [PATCH 6/7] Update docs/user_guide/branding.rst

Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
---
 docs/user_guide/branding.rst | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/docs/user_guide/branding.rst b/docs/user_guide/branding.rst
index a0a8a4d1b..23e410022 100644
--- a/docs/user_guide/branding.rst
+++ b/docs/user_guide/branding.rst
@@ -77,10 +77,9 @@ To reference an external website, make sure your link starts with ``http``:
 Customize logo alternative text
 -------------------------------
 
-The logo is by default using "Logo image" as an alternative text of the image. To set
-a specific alt text for this to be accessible to those using screen readers or other
-assistive tech, use the ``html_teme_options["logo"]["alt_text"]`` and provide a new name
-as in the following example:
+You may set a custom ``alt text`` to use with your logo.
+This can make the logo more accessible to those using screen readers or other assistive tech.
+To do so, use ``html_teme_options["logo"]["alt_text"]`` as in the following example:
 
 .. code-block:: python
    :caption: conf.py

From 55fe07c1ff7ed2e5a6355aba72cc8d83781a4c6f Mon Sep 17 00:00:00 2001
From: Chris Holdgraf <choldgraf@gmail.com>
Date: Sun, 28 Aug 2022 14:25:47 +0200
Subject: [PATCH 7/7] Update docs/user_guide/branding.rst

Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com>
---
 docs/user_guide/branding.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/user_guide/branding.rst b/docs/user_guide/branding.rst
index 23e410022..9ce7c290f 100644
--- a/docs/user_guide/branding.rst
+++ b/docs/user_guide/branding.rst
@@ -77,7 +77,7 @@ To reference an external website, make sure your link starts with ``http``:
 Customize logo alternative text
 -------------------------------
 
-You may set a custom ``alt text`` to use with your logo.
+You may set a custom ``alt text`` to use with your logo to replace the default ("logo image").
 This can make the logo more accessible to those using screen readers or other assistive tech.
 To do so, use ``html_teme_options["logo"]["alt_text"]`` as in the following example: