Allow an arbitrary string in the logo_name option (#213)

Co-authored-by: Will Vousden <will@vousden.me.uk>
sphinx-doc · Jan 8, 2024 · 848e718 · 848e718
1 parent 6922a16
commit 848e718
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/alabaster/about.html b/alabaster/about.html
@@ -1,9 +1,11 @@
 {% if theme_logo %}
 <p class="logo">
   <a href="{{ pathto(master_doc) }}">
-    <img class="logo" src="{{ pathto('_static/' ~ theme_logo, 1) }}" alt="Logo"/>
+    <img class="logo" src="{{ pathto('_static/' ~ theme_logo, 1) }}" alt="Logo" />
     {% if theme_logo_name|lower == 'true' %}
     <h1 class="logo logo-name">{{ project }}</h1>
+    {% elif theme_logo_name %}
+    <h1 class="logo logo-name">{{ theme_logo_name }}</h1>
     {% endif %}
   </a>
 </p>

diff --git a/docs/customization.rst b/docs/customization.rst
@@ -90,9 +90,9 @@ Settings related to text display, logo, etc.
     level Sphinx config) will be used in a text header instead. This
     preserves a link back to your homepage from inner doc pages.
 
-* ``logo_name``: Set to ``true`` to insert your site's ``project`` name
-  under the logo image as text. Useful if your logo doesn't include the
-  project name itself.
+* ``logo_name``: Set to ``True`` to insert your site's ``project`` name
+  under the logo image as text, or to any string to include arbitrary text.
+  Useful if your logo doesn't include the project name itself.
 * ``logo_text_align``: Which CSS ``text-align`` value to use for logo text
   (if there is any.)
 * ``page_width``: CSS width specifier controlling default content/page width.