Merge branch 'master' into pad-literal-blocks

Author: jessetan

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "sphinx-rtd-theme",
-  "version": "0.2.4",
+  "version": "0.3.1",
   "homepage": "https://github.com/rtfd/sphinx_rtd_theme",
   "authors": [
     "Dave Snider, Read the Docs, Inc. & contributors <[email protected]>"

docs/changelog.rst

@@ -3,20 +3,18 @@
 Changelog
 *********
 
-master
+v0.3.1
 ======
 
-New Features
--------------
-
 Fixes
 -----
 
+* Revert part of #576 causing display issues with version selector menu
+* Backwards compatibility fixes for pre-0.3.0 releases (#623)
+* Fix mkdocs version selector (#622)
+* Add open list spacing (#591)
 * Fix table centering (#599)
 
-Other Changes
---------------
-
 v0.3.0
 ======
 

js/theme.js

@@ -18,6 +18,14 @@ function ThemeNav () {
     nav.enable = function (withStickyNav) {
         var self = this;
 
+        // TODO this can likely be removed once the theme javascript is broken
+        // out from the RTD assets. This just ensures old projects that are
+        // calling `enable()` get the sticky menu on by default. All other cals
+        // to `enable` should include an argument for enabling the sticky menu.
+        if (typeof(withStickNav) == 'undefined') {
+            withStickyNav = true;
+        }
+
         if (self.isRunning) {
             // Only allow enabling nav logic once
             return;
@@ -55,6 +63,8 @@ function ThemeNav () {
 
     };
 
+    // TODO remove this with a split in theme and Read the Docs JS logic as
+    // well, it's only here to support 0.3.0 installs of our theme.
     nav.enableSticky = function() {
         this.enable(true);
     };
@@ -190,7 +200,13 @@ function ThemeNav () {
 module.exports.ThemeNav = ThemeNav();
 
 if (typeof(window) != 'undefined') {
-    window.SphinxRtdTheme = { Navigation: module.exports.ThemeNav };
+    window.SphinxRtdTheme = {
+        Navigation: module.exports.ThemeNav,
+        // TODO remove this once static assets are split up between the theme
+        // and Read the Docs. For now, this patches 0.3.0 to be backwards
+        // compatible with a pre-0.3.0 layout.html
+        StickyNav: module.exports.ThemeNav,
+    };
 }
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sphinx_rtd_theme",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "private": true,
   "devDependencies": {
     "bower": "^1.8.4",

sass/_theme_badge.sass

@@ -2,7 +2,6 @@
   position: fixed
   bottom: 0
   left: 0
-  overflow-y: scroll
   width: $nav-desktop-width
   color: $section-background-color
   background: darken($menu-background-color, 8%)
@@ -35,6 +34,7 @@
       background-color: $yellow
       color: $black
   &.shift-up
+    height: auto
     max-height: 100%
   &.shift-up .rst-other-versions
     display: block

sphinx_rtd_theme/__init__.py

@@ -5,7 +5,7 @@
 """
 from os import path
 
-__version__ = '0.3.0'
+__version__ = '0.3.1'
 __version_full__ = __version__
 
 

sphinx_rtd_theme/layout.html

@@ -215,11 +215,7 @@
 
   <script type="text/javascript">
       jQuery(function () {
-          {% if theme_sticky_navigation|tobool %}
-          SphinxRtdTheme.Navigation.enableSticky();
-          {% else %}
-          SphinxRtdTheme.Navigation.enable();
-          {% endif %}
+          SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
       });
   </script>