Merge branch 'master' into always-bundle-js-css

.gitattributes

@@ -0,0 +1,15 @@
+# Document global line endings settings
+# https://help.github.com/articles/dealing-with-line-endings/
+*       text eol=lf
+
+
+# Denote all files that are truly binary and should not be modified.
+*.ai    binary
+*.jpg   binary
+*.otf   binary
+*.png   binary
+*.eot   binary
+*.ttf   binary
+*.whl   binary
+*.woff  binary
+*.woff2 binary

Apache-License-2.0.txt

@@ -1,5 +1,4 @@
-sphinx_rtd_theme/static/fonts/RobotoSlab-Bold.ttf
+/fonts/RobotoSlab/*
-sphinx_rtd_theme/static/fonts/RobotoSlab-Regular.tt/
 
 
                                  Apache License

Gruntfile.js

@@ -4,6 +4,9 @@ module.exports = function(grunt) {
   require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
 
   grunt.initConfig({
+    // Read package.json
+    pkg: grunt.file.readJSON("package.json"),
+
     open : {
       dev: {
         path: 'http://localhost:1919'
@@ -32,27 +35,15 @@ module.exports = function(grunt) {
           {
               expand: true,
               flatten: true,
-              src: ['bower_components/lato-googlefont/Lato-Regular.ttf',
+              src: ['fonts/Lato/*'],
-                    'bower_components/lato-googlefont/Lato-Italic.ttf',
+              dest: 'sphinx_rtd_theme/static/fonts/Lato',
-                    'bower_components/lato-googlefont/Lato-Bold.ttf',
-                    'bower_components/lato-googlefont/Lato-BoldItalic.ttf'],
-              dest: 'sphinx_rtd_theme/static/fonts/',
               filter: 'isFile'
           },
           {
               expand: true,
               flatten: true,
-              src: ['bower_components/robotoslab-googlefont/RobotoSlab-Bold.ttf',
+              src: ['fonts/RobotoSlab/*'],
-                    'bower_components/robotoslab-googlefont/RobotoSlab-Regular.ttf'],
+              dest: 'sphinx_rtd_theme/static/fonts/RobotoSlab/',
-              dest: 'sphinx_rtd_theme/static/fonts/',
-              filter: 'isFile'
-          },
-          {
-              expand: true,
-              flatten: true,
-              src: ['bower_components/inconsolata-googlefont/Inconsolata-Bold.ttf',
-                    'bower_components/inconsolata-googlefont/Inconsolata-Regular.ttf'],
-              dest: 'sphinx_rtd_theme/static/fonts/',
               filter: 'isFile'
           }
         ]
@@ -131,6 +122,19 @@ module.exports = function(grunt) {
         }]
       }
     },
+    usebanner: {
+      dist: {
+        options: {
+          position: 'top',
+          banner: '/* <%= pkg.name %> version <%= pkg.version %> | MIT license */\n' +
+                  '/* Built <%= grunt.template.today("yyyymmdd HH:mm") %> */',
+          linebreak: true
+        },
+        files: {
+          src: [ 'sphinx_rtd_theme/static/js/theme.js', 'sphinx_rtd_theme/static/css/theme.css' ]
+        }
+      }
+    },
     exec: {
       bower_update: {
         cmd: 'bower update'
@@ -180,6 +184,6 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-open');
   grunt.loadNpmTasks('grunt-browserify');
 
-  grunt.registerTask('default', ['exec:bower_update','clean','copy:fonts','sass:dev','browserify:dev','exec:build_sphinx','connect','open','watch']);
+  grunt.registerTask('default', ['exec:bower_update','clean','copy:fonts','sass:dev','browserify:dev','usebanner','exec:build_sphinx','connect','open','watch']);
-  grunt.registerTask('build', ['exec:bower_update','clean','copy:fonts','sass:build','browserify:build','uglify','exec:build_sphinx']);
+  grunt.registerTask('build', ['exec:bower_update','clean','copy:fonts','sass:build','browserify:build','uglify','usebanner','exec:build_sphinx']);
 }

OFL-License.txt

@@ -1,104 +1,96 @@
-sphinx_rtd_theme/static/fonts/Inconsolata-Bold.ttf
+sphinx_rtd_theme/static/fonts/Lato/*
-sphinx_rtd_theme/static/fonts/Lato-Bold.ttf
+
-sphinx_rtd_theme/static/fonts/Inconsolata.ttf
+Copyright (c) 2010-2015, Łukasz Dziedzic (dziedzic@typoland.com),
-sphinx_rtd_theme/static/fonts/Lato-Regular.ttf
+with Reserved Font Name Lato.
-
+
-
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
-
+This license is copied below, and is also available with a FAQ at:
-Copyright (c) <dates>, <Copyright Holder> (<URL|email>),
+http://scripts.sil.org/OFL
-with Reserved Font Name <Reserved Font Name>.
+
-Copyright (c) <dates>, <additional Copyright Holder> (<URL|email>),
+
-with Reserved Font Name <additional Reserved Font Name>.
+-----------------------------------------------------------
-Copyright (c) <dates>, <additional Copyright Holder> (<URL|email>).
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-
+-----------------------------------------------------------
-This Font Software is licensed under the SIL Open Font License, Version 1.1.
+
-This license is copied below, and is also available with a FAQ at:
+PREAMBLE
-http://scripts.sil.org/OFL
+The goals of the Open Font License (OFL) are to stimulate worldwide
-
+development of collaborative font projects, to support the font creation
-
+efforts of academic and linguistic communities, and to provide a free and
------------------------------------------------------------
+open framework in which fonts may be shared and improved in partnership
-SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+with others.
------------------------------------------------------------
+
-
+The OFL allows the licensed fonts to be used, studied, modified and
-PREAMBLE
+redistributed freely as long as they are not sold by themselves. The
-The goals of the Open Font License (OFL) are to stimulate worldwide
+fonts, including any derivative works, can be bundled, embedded, 
-development of collaborative font projects, to support the font creation
+redistributed and/or sold with any software provided that any reserved
-efforts of academic and linguistic communities, and to provide a free and
+names are not used by derivative works. The fonts and derivatives,
-open framework in which fonts may be shared and improved in partnership
+however, cannot be released under any other type of license. The
-with others.
+requirement for fonts to remain under this license does not apply
-
+to any document created using the fonts or their derivatives.
-The OFL allows the licensed fonts to be used, studied, modified and
+
-redistributed freely as long as they are not sold by themselves. The
+DEFINITIONS
-fonts, including any derivative works, can be bundled, embedded, 
+"Font Software" refers to the set of files released by the Copyright
-redistributed and/or sold with any software provided that any reserved
+Holder(s) under this license and clearly marked as such. This may
-names are not used by derivative works. The fonts and derivatives,
+include source files, build scripts and documentation.
-however, cannot be released under any other type of license. The
+
-requirement for fonts to remain under this license does not apply
+"Reserved Font Name" refers to any names specified as such after the
-to any document created using the fonts or their derivatives.
+copyright statement(s).
-
+
-DEFINITIONS
+"Original Version" refers to the collection of Font Software components as
-"Font Software" refers to the set of files released by the Copyright
+distributed by the Copyright Holder(s).
-Holder(s) under this license and clearly marked as such. This may
+
-include source files, build scripts and documentation.
+"Modified Version" refers to any derivative made by adding to, deleting,
-
+or substituting -- in part or in whole -- any of the components of the
-"Reserved Font Name" refers to any names specified as such after the
+Original Version, by changing formats or by porting the Font Software to a
-copyright statement(s).
+new environment.
-
+
-"Original Version" refers to the collection of Font Software components as
+"Author" refers to any designer, engineer, programmer, technical
-distributed by the Copyright Holder(s).
+writer or other person who contributed to the Font Software.
-
+
-"Modified Version" refers to any derivative made by adding to, deleting,
+PERMISSION & CONDITIONS
-or substituting -- in part or in whole -- any of the components of the
+Permission is hereby granted, free of charge, to any person obtaining
-Original Version, by changing formats or by porting the Font Software to a
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
-new environment.
+redistribute, and sell modified and unmodified copies of the Font
-
+Software, subject to the following conditions:
-"Author" refers to any designer, engineer, programmer, technical
+
-writer or other person who contributed to the Font Software.
+1) Neither the Font Software nor any of its individual components,
-
+in Original or Modified Versions, may be sold by itself.
-PERMISSION & CONDITIONS
+
-Permission is hereby granted, free of charge, to any person obtaining
+2) Original or Modified Versions of the Font Software may be bundled,
-a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistributed and/or sold with any software, provided that each copy
-redistribute, and sell modified and unmodified copies of the Font
+contains the above copyright notice and this license. These can be
-Software, subject to the following conditions:
+included either as stand-alone text files, human-readable headers or
-
+in the appropriate machine-readable metadata fields within text or
-1) Neither the Font Software nor any of its individual components,
+binary files as long as those fields can be easily viewed by the user.
-in Original or Modified Versions, may be sold by itself.
+
-
+3) No Modified Version of the Font Software may use the Reserved Font
-2) Original or Modified Versions of the Font Software may be bundled,
+Name(s) unless explicit written permission is granted by the corresponding
-redistributed and/or sold with any software, provided that each copy
+Copyright Holder. This restriction only applies to the primary font name as
-contains the above copyright notice and this license. These can be
+presented to the users.
-included either as stand-alone text files, human-readable headers or
+
-in the appropriate machine-readable metadata fields within text or
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
-binary files as long as those fields can be easily viewed by the user.
+Software shall not be used to promote, endorse or advertise any
-
+Modified Version, except to acknowledge the contribution(s) of the
-3) No Modified Version of the Font Software may use the Reserved Font
+Copyright Holder(s) and the Author(s) or with their explicit written
-Name(s) unless explicit written permission is granted by the corresponding
+permission.
-Copyright Holder. This restriction only applies to the primary font name as
+
-presented to the users.
+5) The Font Software, modified or unmodified, in part or in whole,
-
+must be distributed entirely under this license, and must not be
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+distributed under any other license. The requirement for fonts to
-Software shall not be used to promote, endorse or advertise any
+remain under this license does not apply to any document created
-Modified Version, except to acknowledge the contribution(s) of the
+using the Font Software.
-Copyright Holder(s) and the Author(s) or with their explicit written
+
-permission.
+TERMINATION
-
+This license becomes null and void if any of the above conditions are
-5) The Font Software, modified or unmodified, in part or in whole,
+not met.
-must be distributed entirely under this license, and must not be
+
-distributed under any other license. The requirement for fonts to
+DISCLAIMER
-remain under this license does not apply to any document created
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-using the Font Software.
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-TERMINATION
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-This license becomes null and void if any of the above conditions are
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-not met.
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-DISCLAIMER
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+OTHER DEALINGS IN THE FONT SOFTWARE.
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.

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 <dev@readthedocs.org>"
@@ -29,9 +29,6 @@
     "wyrm": "~1.0.x"
   },
   "dependencies": {
-    "lato-googlefont": "*",
-    "robotoslab-googlefont": "*",
-    "inconsolata-googlefont": "*",
     "font-awesome": "~4.7"
   },
   "resolutions": {

docs/changelog.rst

@@ -3,7 +3,7 @@
 Changelog
 *********
 
-master
+Master
 ======
 
 New Features
@@ -12,12 +12,28 @@ New Features
 Fixes
 -----
 
-* Fix table centering (#599)
 * Do not rely on readthedocs.org for CSS/JS (#614)
+* Color accessibility improvements on the left navigation
 
 Other Changes
 --------------
 
+* Write theme version and build date at top of JavaScript and CSS
+* Changed code and literals to use a native font stack (#612)
+* Fix small styling issues
+
+v0.3.1
+======
+
+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)
+
 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(withStickyNav) == '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,12 +1,13 @@
 {
   "name": "sphinx_rtd_theme",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "private": true,
   "devDependencies": {
     "bower": "^1.8.4",
     "browserify": "^13.0.0",
     "connect-livereload": "~0.6.0",
     "grunt": "~1.0.1",
+    "grunt-banner": "^0.6.0",
     "grunt-browserify": "^5.0.0",
     "grunt-contrib-clean": "^1.0.0",
     "grunt-contrib-connect": "^1.0.2",

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

sass/_theme_font_local.sass

@@ -1,48 +1,41 @@
-@font-face 
+@font-face
-  font-family: 'Inconsolata'
+  font-family: 'Lato'
-  font-style: normal
+  src: url('../fonts/Lato/lato-regular.eot')
+  src: url('../fonts/Lato/lato-regular.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-regular.woff2') format('woff2'), url('../fonts/Lato/lato-regular.woff') format('woff'), url('../fonts/Lato/lato-regular.ttf') format('truetype')
   font-weight: 400
-  src: local('Inconsolata'), local('Inconsolata-Regular'), url(../fonts/Inconsolata-Regular.ttf) format('truetype')
+  font-style: normal
 
 @font-face
-  font-family: 'Inconsolata'
+  font-family: 'Lato'
-  font-style: normal
+  src: url('../fonts/Lato/lato-bold.eot')
+  src: url('../fonts/Lato/lato-bold.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-bold.woff2') format('woff2'), url('../fonts/Lato/lato-bold.woff') format('woff'), url('../fonts/Lato/lato-bold.ttf') format('truetype')
   font-weight: 700
-  src: local('Inconsolata Bold'), local('Inconsolata-Bold'), url(../fonts/Inconsolata-Bold.ttf) format('truetype')
+  font-style: normal
+
 
 @font-face
   font-family: 'Lato'
-  font-style: normal
+  src: url('../fonts/Lato/lato-bolditalic.eot')
-  font-weight: 400
+  src: url('../fonts/Lato/lato-bolditalic.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-bolditalic.woff2') format('woff2'), url('../fonts/Lato/lato-bolditalic.woff') format('woff'), url('../fonts/Lato/lato-bolditalic.ttf') format('truetype')
-  src: local('Lato Regular'), local('Lato-Regular'), url(../fonts/Lato-Regular.ttf) format('truetype')
-
-@font-face
-  font-family: 'Lato'
-  font-style: normal
   font-weight: 700
-  src: local('Lato Bold'), local('Lato-Bold'), url(../fonts/Lato-Bold.ttf) format('truetype')
-
-@font-face
-  font-family: 'Lato'
   font-style: italic
-  font-weight: 400
-  src: local('Lato Italic'), local('Lato-Italic'), url(../fonts/Lato-Italic.ttf) format('truetype')
 
 @font-face
   font-family: 'Lato'
+  src: url('../fonts/Lato/lato-italic.eot')
+  src: url('../fonts/Lato/lato-italic.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-italic.woff2') format('woff2'), url('../fonts/Lato/lato-italic.woff') format('woff'), url('../fonts/Lato/lato-italic.ttf') format('truetype')
+  font-weight: 400
   font-style: italic
-  font-weight: 700
-  src: local('Lato Bold Italic'), local('Lato-BoldItalic'), url(../fonts/Lato-BoldItalic.ttf) format('truetype')
 
 @font-face
   font-family: 'Roboto Slab'
   font-style: normal
   font-weight: 400
-  src: local('Roboto Slab Regular'), local('RobotoSlab-Regular'), url(../fonts/RobotoSlab-Regular.ttf) format('truetype')
+  src: url('../fonts/RobotoSlab/roboto-slab.eot')
+  src: url('../fonts/RobotoSlab/roboto-slab-v7-regular.eot?#iefix') format('embedded-opentype'), url('../fonts/RobotoSlab/roboto-slab-v7-regular.woff2') format('woff2'), url('../fonts/RobotoSlab/roboto-slab-v7-regular.woff') format('woff'), url('../fonts/RobotoSlab/roboto-slab-v7-regular.ttf') format('truetype')
 
-@font-face 
+@font-face
   font-family: 'Roboto Slab'
   font-style: normal
   font-weight: 700
   src: local('Roboto Slab Bold'), local('RobotoSlab-Bold'), url(../fonts/RobotoSlab-Bold.ttf) format('truetype')
-

sass/_theme_layout.sass

@@ -25,6 +25,7 @@
 
 .wy-menu-vertical
   width: $nav-desktop-width
+
   header, p.caption
     height: $base-font-size * 2
     display: inline-block
@@ -35,7 +36,6 @@
     font-weight: bold
     text-transform: uppercase
     font-size: 80%
-    color: $menu-dark
     white-space: nowrap
 
   ul
@@ -97,6 +97,8 @@
     border-top: solid 1px darken($menu-vertical-background-color, 20%)
 
   // This is the on state for pages beyond second level
+  li.toctree-l2 a, li.toctree-l3 a, li.toctree-l4 a
+    color: $menu-link-color
   li.toctree-l1.current li.toctree-l2, li.toctree-l2.current li.toctree-l3
     > ul
       display: none
@@ -261,6 +263,7 @@
   overflow-x: hidden
   overflow-y: hidden
   min-height: 100%
+  color: $menu-medium
   background: $nav-background-color
   z-index: $z-index-popover
 

sass/_theme_rst.sass

@@ -53,13 +53,20 @@
     line-height: $base-line-height
     margin-bottom: $base-line-height
 
+  pre.literal-block
+    white-space: pre
+    margin: 0
+    padding: $base-line-height / 2 $base-line-height / 2
+    font-family: $code-font-family
+    display: block
+    overflow: auto
   pre.literal-block, div[class^='highlight']
     border: 1px solid $table-border-color
-    padding: 0px
     overflow-x: auto
     // 1px hack otherwise border won't show. lame
     margin: 1px 0 $base-line-height 0
     div[class^='highlight']
+      padding: 0px
       border: none
       margin: 0
   // Needs 100% width for line highlighting to work properly
@@ -76,7 +83,6 @@
     white-space: pre
     margin: 0
     padding: $base-line-height / 2 $base-line-height / 2
-    font-family: $code-font-family
     display: block
     overflow: auto
     & .hll
@@ -85,6 +91,7 @@
       margin: 0 -1 * $base-line-height / 2
       padding: 0 $base-line-height / 2
   pre.literal-block, div[class^='highlight'] pre, .linenodiv pre
+    font-family: $code-font-family
     font-size: 12px
     line-height: normal
 
@@ -132,6 +139,7 @@
   .line-block
     margin-left: 0px
     margin-bottom: $base-line-height
+    line-height: $base-line-height
   .line-block .line-block
     margin-left: $base-line-height
     margin-bottom: 0px
@@ -246,6 +254,9 @@
       border-color: $table-border-color
     &:not(.field-list)
       @extend .wy-table-striped
+    // Remove bottom margin for the last element (and it's last child)
+    td .last, td .last :last-child
+      margin-bottom: 0
   // This table is what gets spit out for auto-generated API stuff. I style it smaller bits of padding.
   table.field-list
     @extend .wy-table
@@ -265,6 +276,7 @@
   tt, code
     @extend code
     color: $black
+    font-family: $code-font-family
     padding: 2px 5px
     big, em
       font-size: 100% !important
@@ -275,6 +287,8 @@
     &.xref, a &
       font-weight: bold
       color: $text-codexref-color
+  pre, kbd, samp
+    font-family: $code-font-family
   // If the literal is inside an a tag, let's color it like a link
   a tt, a code
     color: $link-color
@@ -282,12 +296,14 @@
     margin-bottom: $base-line-height
     dt
       font-weight: bold
+      margin-bottom: $base-line-height / 2
     // Most of the content within these dls are one liners, so I halve the normal margins.
     p, table, ul, ol
       margin-bottom: $base-line-height / 2 !important
     // rST seems to want dds to be treated as the browser would, indented.
     dd
       margin: 0  0 $base-line-height / 2 $base-line-height
+      line-height: $base-line-height
   // This is what Sphinx spits out for it's autodocs. Depending upon what language the person is referencing
   // these things usually have a class of "method" or "class" or something similar, but really who knows.
   // Sphinx doesn't give me a generic class on these, so unfortunately I have to apply it to the root dl.

sass/_theme_variables.sass

@@ -32,7 +32,7 @@ $menu-vertical-background-color:      $section-background-color
 // Menu text colors
 $menu-color:                          $gray
 $menu-dark:                           lighten($menu-color,10%) !default
-$menu-medium:                         lighten($menu-color,25%) !default
+$menu-medium:                         lighten($menu-color,27.5%) !default
 $menu-light:                          lighten($menu-color,45%) !default
 $menu-lighter:                        lighten($menu-color,60%) !default
 
@@ -40,7 +40,7 @@ $menu-lighter:                        lighten($menu-color,60%) !default
 $menu-link-color:                     $text-color
 $menu-link-dark:                      $text-dark
 $menu-link-medium:                    $text-medium
-$menu-link-light:                     $text-light
+$menu-link-light:                     $text-lighter
 $menu-link-active:                    $white
 
 // Navigation colors
@@ -63,4 +63,4 @@ $highlight-color:                     $yellow
 $base-font-family:                    "Lato", "proxima-nova", "Helvetica Neue", Arial, sans-serif
 $custom-font-family:                  "Roboto Slab", "ff-tisa-web-pro", "Georgia", Arial, sans-serif
 $custom-font-family2:                 Georgia, serif
-$code-font-family:                    Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace
+$code-font-family:                    SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", Courier, monospace

sphinx_rtd_theme/__init__.py

@@ -5,7 +5,7 @@ From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
 """
 from os import path
 
-__version__ = '0.3.0'
+__version__ = '0.3.1'
 __version_full__ = __version__
 
 

sphinx_rtd_theme/layout.html

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

sphinx_rtd_theme/static/css/badge_only.css

@@ -1 +1 @@
-.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;overflow-y:scroll;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
+.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}

sphinx_rtd_theme/static/js/theme.js

@@ -1 +1 @@
-require=function r(s,a,l){function c(i,n){if(!a[i]){if(!s[i]){var e="function"==typeof require&&require;if(!n&&e)return e(i,!0);if(u)return u(i,!0);var t=new Error("Cannot find module '"+i+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[i]={exports:{}};s[i][0].call(o.exports,function(n){var e=s[i][1][n];return c(e||n)},o,o.exports,r,s,a,l)}return a[i].exports}for(var u="function"==typeof require&&require,n=0;n<l.length;n++)c(l[n]);return c}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(e){var i=this;i.isRunning||(i.isRunning=!0,jQuery(function(n){i.init(n),i.reset(),i.win.on("hashchange",i.reset),e&&i.win.on("scroll",function(){i.linkScroll||i.winScroll||(i.winScroll=!0,requestAnimationFrame(function(){i.onScroll()}))}),i.win.on("resize",function(){i.winResize||(i.winResize=!0,requestAnimationFrame(function(){i.onResize()}))}),i.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(i){i(document);var t=this;this.navBar=i("div.wy-side-scroll:first"),this.win=i(window),i(document).on("click","[data-toggle='wy-nav-top']",function(){i("[data-toggle='wy-nav-shift']").toggleClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var n=i(this);i("[data-toggle='wy-nav-shift']").removeClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift"),t.toggleCurrent(n),t.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){i("[data-toggle='rst-versions']").toggleClass("shift-up")}),i("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),i("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),i("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var e=i(this);expand=i('<span class="toctree-expand"></span>'),expand.on("click",function(n){return t.toggleCurrent(e),n.stopPropagation(),!1}),e.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}0<i.length&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"))}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav}),function(){for(var r=0,n=["ms","moz","webkit","o"],e=0;e<n.length&&!window.requestAnimationFrame;++e)window.requestAnimationFrame=window[n[e]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[n[e]+"CancelAnimationFrame"]||window[n[e]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(n,e){var i=(new Date).getTime(),t=Math.max(0,16-(i-r)),o=window.setTimeout(function(){n(i+t)},t);return r=i+t,o}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);
+require=function r(s,a,l){function c(i,n){if(!a[i]){if(!s[i]){var e="function"==typeof require&&require;if(!n&&e)return e(i,!0);if(u)return u(i,!0);var t=new Error("Cannot find module '"+i+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[i]={exports:{}};s[i][0].call(o.exports,function(n){var e=s[i][1][n];return c(e||n)},o,o.exports,r,s,a,l)}return a[i].exports}for(var u="function"==typeof require&&require,n=0;n<l.length;n++)c(l[n]);return c}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(e){var i=this;"undefined"==typeof withStickNav&&(e=!0),i.isRunning||(i.isRunning=!0,jQuery(function(n){i.init(n),i.reset(),i.win.on("hashchange",i.reset),e&&i.win.on("scroll",function(){i.linkScroll||i.winScroll||(i.winScroll=!0,requestAnimationFrame(function(){i.onScroll()}))}),i.win.on("resize",function(){i.winResize||(i.winResize=!0,requestAnimationFrame(function(){i.onResize()}))}),i.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(i){i(document);var t=this;this.navBar=i("div.wy-side-scroll:first"),this.win=i(window),i(document).on("click","[data-toggle='wy-nav-top']",function(){i("[data-toggle='wy-nav-shift']").toggleClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var n=i(this);i("[data-toggle='wy-nav-shift']").removeClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift"),t.toggleCurrent(n),t.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){i("[data-toggle='rst-versions']").toggleClass("shift-up")}),i("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),i("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),i("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var e=i(this);expand=i('<span class="toctree-expand"></span>'),expand.on("click",function(n){return t.toggleCurrent(e),n.stopPropagation(),!1}),e.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}0<i.length&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"))}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var r=0,n=["ms","moz","webkit","o"],e=0;e<n.length&&!window.requestAnimationFrame;++e)window.requestAnimationFrame=window[n[e]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[n[e]+"CancelAnimationFrame"]||window[n[e]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(n,e){var i=(new Date).getTime(),t=Math.max(0,16-(i-r)),o=window.setTimeout(function(){n(i+t)},t);return r=i+t,o}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);