Toggle to show/hide theme version in docs

wagtail · Oct 28, 2024 · 6642ccd · 6642ccd
1 parent dac8514
commit 6642ccd
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 10 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,7 @@
 
 # -- Options for HTML output -------------------------------------------
 html_theme = "sphinx_wagtail_theme"
+html_show_sphinx = True
 html_static_path = []
 html_favicon = "favicon.ico"
 # -- Options for HTMLHelp output ---------------------------------------

diff --git a/docs/customizing.rst b/docs/customizing.rst
@@ -80,6 +80,15 @@ are valid here. To disable, set to ``None``
 
    html_last_updated_fmt = "%b %d, %Y"
 
+Show Sphinx Theme in Footer
+---------------------------
+
+This built-in Sphinx feature will toggle on or off the "Created using Sphinx Wagtail Theme" in footer. By default it is on. To disable, set to ``False``. Useful if you want to see what version your docs are built with, or want to promote the project.
+
+.. code-block:: python
+
+   html_show_sphinx = False
+
 Custom Fonts & CSS
 ------------------
 

diff --git a/sphinx_wagtail_theme/footer.html b/sphinx_wagtail_theme/footer.html
@@ -12,16 +12,6 @@
                     </ul>
                 </nav>
             {% endif %}
-            <div class="text-center">
-                {%- if last_updated %}
-                <p>Last updated: {{ last_updated|e }}</p>
-                {%- endif %}
-                <p style="display: none">
-                    <a class="text-light" href="https://github.com/wagtail/sphinx_wagtail_theme" rel="nofollow" target="_blank">
-                        Wagtail Sphinx Theme {{ theme_version|e }}
-                    </a>
-                </p>
-            </div>
             {%- if show_copyright %}
             <div class="text-center">
                 {%- if hasdoc('Copyright') %}
@@ -33,6 +23,21 @@
                 {%- endif %}
             </div>
             {%- endif %}
+            {%- if last_updated or show_sphinx %}
+            <div class="text-center text-white-50 font-italic mt-3">
+                {%- if last_updated %}
+                <small>Last updated: {{ last_updated|e }}</small>
+                {%- endif %}
+                {%- if show_sphinx %}
+                <small>
+                    Created using
+                    <a href="https://github.com/wagtail/sphinx_wagtail_theme" rel="nofollow" target="_blank">
+                        Sphinx Wagtail Theme {{ theme_version|e }}
+                    </a>
+                </small>
+                {%- endif %}
+            </div>
+            {%- endif %}
         </div>
     </div>
 {%- endblock %}