Allow users to show custom version values (#1624)

Add support for custom version strings in selfhosted builds. This
revives the 'display_version' config option, setting it to default value
of False. If the language or version selection is enabled it will be
prioritized over 'display_version'.

Signed-off-by: Randolph Sapp <[email protected]>

Author: StaticRocket

docs/configuring.rst

@@ -16,12 +16,13 @@ For example:
         'analytics_id': 'G-XXXXXXXXXX',  #  Provided by Google in your dashboard
         'analytics_anonymize_ip': False,
         'logo_only': False,
+        'display_version': True,
         'prev_next_buttons_location': 'bottom',
         'style_external_links': False,
         'vcs_pageview_mode': '',
         'style_nav_header_background': 'white',
         'flyout_display': 'hidden',
-        'version_selector': True,
+        'version_selector': True,  #  Will be prioritized over display_version
         'language_selector': True,
         # Toc options
         'collapse_navigation': True,

sphinx_rtd_theme/layout.html

@@ -131,6 +131,13 @@
                 <div class="language-switch"></div>
               </div>
             {%- endif %}
+          {%- elif theme_display_version %}
+            {%- set nav_version = version %}
+            {%- if nav_version %}
+              <div class="version">
+                {{ nav_version }}
+              </div>
+            {%- endif %}
           {%- endif %}
 
           {%- include "searchbox.html" %}

sphinx_rtd_theme/static/css/theme.css

@@ -13,6 +13,7 @@ navigation_depth = 4
 includehidden = True
 titles_only =
 logo_only =
+display_version = True
 prev_next_buttons_location = bottom
 style_external_links = False
 style_nav_header_background =

sphinx_rtd_theme/theme.conf

@@ -231,6 +231,11 @@ html
       display: block
       img.logo
         margin-top: 0.85em  // space it away from the title text
+  > div.version
+    margin-top: -1 * $gutter / 4
+    margin-bottom: $gutter / 2
+    font-weight: normal
+    color: rgba(255, 255, 255, 0.3)
   > div.switch-menus
     position: relative
     display: block