Merge branch 'master' into agj/docs-config-updates

.gitattributes

@@ -1,6 +1,7 @@
 # Document global line endings settings
 # https://help.github.com/articles/dealing-with-line-endings/
 *       text eol=lf
+*.bat   text eol=crlf
 
 
 # Denote all files that are truly binary and should not be modified.

.travis.yml

@@ -8,7 +8,6 @@ matrix:
   include:
     - python: 2.7
       env: TOXENV=docs
-sudo: false
 install:
   - pip install tox-travis
 script:

docs/configuring.rst

@@ -20,6 +20,8 @@ For example:
         'prev_next_buttons_location': 'bottom',
         'style_external_links': False,
         'vcs_pageview_mode': '',
+        'style_nav_header_background': 'white',
+        # Toc options
         'collapse_navigation': True,
         'sticky_navigation': True,
         'navigation_depth': 4,
@@ -151,6 +153,15 @@ Miscellaneous options
     or ``raw``. On Bitbucket, this can be either: ``view`` (default) or
     ``edit``.
 
+.. confval:: style_nav_header_background
+
+    :type: string
+    :default: ``None``
+
+* Changes the background of the search area in the navigation bar. The value
+  can be anything valid in a CSS `background` property. The default `#2980B9` will be used if the property is not
+  defined.
+
 .. _canonical URL: https://en.wikipedia.org/wiki/Canonical_link_element
 
 

docs/make.bat

@@ -1,38 +1,38 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=python -msphinx
-)
-set SPHINXOPTS=
-set SPHINXBUILD=sphinx-build
-set SOURCEDIR=.
-set BUILDDIR=build
-set SPHINXPROJ=ReadtheDocsSphinxTheme
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
-	echo.then set the SPHINXBUILD environment variable to point to the full
-	echo.path of the 'sphinx-build' executable. Alternatively you may add the
-	echo.Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-
-:end
-popd
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SPHINXOPTS=
+set SPHINXBUILD=sphinx-build
+set SOURCEDIR=.
+set BUILDDIR=build
+set SPHINXPROJ=ReadtheDocsSphinxTheme
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

sass/_theme_badge.sass

@@ -36,6 +36,7 @@
   &.shift-up
     height: auto
     max-height: 100%
+    overflow-y: scroll
   &.shift-up .rst-other-versions
     display: block
   .rst-other-versions
@@ -64,6 +65,7 @@
     left: auto
     border: none
     max-width: $nav-desktop-width
+    max-height: 90%
     .icon-book
       float: none
     .fa-book

sphinx_rtd_theme/breadcrumbs.html

@@ -74,7 +74,7 @@
         <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
       {% endif %}
       {% if prev %}
-        <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       {% endif %}
   </div>
   {% endif %}

sphinx_rtd_theme/footer.html

@@ -5,7 +5,7 @@
         <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
       {% endif %}
       {% if prev %}
-        <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
+        <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
       {% endif %}
     </div>
   {% endif %}

sphinx_rtd_theme/layout.html

@@ -105,11 +105,10 @@
 
   {% block extrabody %} {% endblock %}
   <div class="wy-grid-for-nav">
-
     {# SIDE NAV, TOGGLES ON MOBILE #}
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
-        <div class="wy-side-nav-search">
+        <div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
           {% block sidebartitle %}
 
           {% if logo and theme_logo_only %}

sphinx_rtd_theme/theme.conf

@@ -10,8 +10,9 @@ collapse_navigation = True
 sticky_navigation = True
 navigation_depth = 4
 includehidden = True
-titles_only = 
+titles_only =
 logo_only =
 display_version = True
 prev_next_buttons_location = bottom
 style_external_links = False
+style_nav_header_background =