Merge branch 'master' into agj/update-translations-rebase

Author: agjohnson

docs/changelog.rst

@@ -11,6 +11,8 @@ New Features
 Fixes
 -----
 
+* Fix definition lists looking different with Sphinx 2.0+
+
 Other Changes
 --------------
 

docs/demo/demo.rst

@@ -25,7 +25,7 @@ citation references ([12]_), substitution references (|example|), and _`inline h
 text (generated by processing errors; this one is intentional).
 
 Also with ``sphinx.ext.autodoc``, which I use in the demo, I can link to :class:`test_py_module.test.Foo`.
-It will link you right my code documentation for it.
+It will link you right to my code documentation for it.
 
 The default role for interpreted text is `Title Reference`.  Here are some explicit interpreted text roles:
 a PEP reference (:PEP:`287`); an RFC reference (:RFC:`2822`); a :sub:`subscript`; a :sup:`superscript`;

sass/_theme_font_local.sass

@@ -4,39 +4,44 @@
   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
   font-style: normal
+  font-display: $font-display
 
 @font-face
   font-family: 'Lato'
   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
   font-style: normal
-
+  font-display: $font-display
 
 @font-face
   font-family: 'Lato'
   src: url('../fonts/Lato/lato-bolditalic.eot')
   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')
   font-weight: 700
   font-style: italic
+  font-display: $font-display
 
 @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-display: $font-display
 
 @font-face
   font-family: 'Roboto Slab'
   font-style: normal
   font-weight: 400
   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-display: $font-display
 
 @font-face
   font-family: 'Roboto Slab'
   font-style: normal
   font-weight: 700
   src: url('../fonts/RobotoSlab/roboto-slab-v7-bold.eot')
   src: url('../fonts/RobotoSlab/roboto-slab-v7-bold.eot?#iefix') format('embedded-opentype'), url('../fonts/RobotoSlab/roboto-slab-v7-bold.woff2') format('woff2'), url('../fonts/RobotoSlab/roboto-slab-v7-bold.woff') format('woff'), url('../fonts/RobotoSlab/roboto-slab-v7-bold.ttf') format('truetype')
+  font-display: $font-display

sass/_theme_rst.sass

@@ -323,54 +323,56 @@
   // This makes me terribly unhappy and makes this code very nesty. Unfortunately I've seen hand-written docs
   // that output similar, but not quite the same nesting so this is really the best we can do.
   dl:not(.docutils)
-    margin-bottom: $base-line-height
-    // This would be the equivilant of a .. class::
-    dt
-      display: table
-      margin: $base-line-height / 4 0
-      font-size: 90%
-      line-height: normal
-      background: lighten($class-color, 50%)
-      color: $class-color
-      border-top: solid 3px lighten($class-color, 20%)
-      padding: $base-line-height / 4
-      position: relative
-      &:before
-        color: lighten($class-color, 20%)
-      .headerlink
-        color: $text-color
-        font-size: 100% !important
-    // And this would be the .. method::
-    dl dt
-      margin-bottom: $base-line-height / 4
-      border: none
-      border-left: solid 3px hsl(0,0%,80%)
-      background: hsl(0,0%,94%)
-      color: $method-color
-      .headerlink
-        color: $headerlink-color
-        font-size: 100% !important
-    dt:first-child
-      margin-top: 0
-    // Since dts get the callout style, we treat this less as callouts.
-    tt, code
-      font-weight: bold
-      &.descname, &.descclassname
-        background-color: transparent
+    // In Sphinx 2.0+ most DLs no longer contain .docutils, needs tighter scoping using next line
+    &.class, &.data
+      margin-bottom: $base-line-height
+      // This would be the equivilant of a .. class::
+      dt
+        display: table
+        margin: $base-line-height / 4 0
+        font-size: 90%
+        line-height: normal
+        background: lighten($class-color, 50%)
+        color: $class-color
+        border-top: solid 3px lighten($class-color, 20%)
+        padding: $base-line-height / 4
+        position: relative
+        &:before
+          color: lighten($class-color, 20%)
+        .headerlink
+          color: $text-color
+          font-size: 100% !important
+      // And this would be the .. method::
+      dl dt
+        margin-bottom: $base-line-height / 4
         border: none
-        padding: 0
-        font-size: 100% !important
-      &.descname
+        border-left: solid 3px hsl(0,0%,80%)
+        background: hsl(0,0%,94%)
+        color: $method-color
+        .headerlink
+          color: $headerlink-color
+          font-size: 100% !important
+      dt:first-child
+        margin-top: 0
+      // Since dts get the callout style, we treat this less as callouts.
+      tt, code
         font-weight: bold
-    // This is for more advanced parameter control
-    .optional
-      display: inline-block
-      padding: 0 4px
-      color: $black
-      font-weight: bold
-    .property
-      display: inline-block
-      padding-right: 8px
+        &.descname, &.descclassname
+          background-color: transparent
+          border: none
+          padding: 0
+          font-size: 100% !important
+        &.descname
+          font-weight: bold
+      // This is for more advanced parameter control
+      .optional
+        display: inline-block
+        padding: 0 4px
+        color: $black
+        font-weight: bold
+      .property
+        display: inline-block
+        padding-right: 8px
   // Doc links to sourcecode
   .viewcode-link, .viewcode-back
     display: inline-block

sass/_theme_variables.sass

@@ -65,3 +65,5 @@ $base-font-family:                    "Lato", "proxima-nova", "Helvetica Neue",
 $custom-font-family:                  "Roboto Slab", "ff-tisa-web-pro", "Georgia", Arial, sans-serif
 $custom-font-family2:                 Georgia, serif
 $code-font-family:                    SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", Courier, monospace
+
+$font-display:                        swap

sphinx_rtd_theme/layout.html

@@ -29,6 +29,7 @@
   {% endif %}
 
   {# JAVASCRIPTS #}
+  {%- block scripts %}
   <script type="text/javascript" src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
   {%- if not embedded %}
   {# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
@@ -62,6 +63,7 @@
           href="{{ pathto('_static/opensearch.xml', 1) }}"/>
     {%- endif %}
   {%- endif %}
+  {%- endblock %}
 
   {# CSS #}
   <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />

sphinx_rtd_theme/search.html

@@ -9,7 +9,10 @@
 #}
 {%- extends "layout.html" %}
 {% set title = _('Search') %}
-{% set script_files = script_files + ['_static/searchtools.js'] %}
+{%- block scripts %}
+    {{ super() }}
+    <script type="text/javascript" src="{{ pathto('_static/searchtools.js', 1) }}"></script>
+{%- endblock %}
 {% block footer %}
   <script type="text/javascript">
     jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });