Merge branch 'master' into master

.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:

MANIFEST.in

@@ -11,4 +11,6 @@ recursive-include sphinx_rtd_theme *.ttf
 recursive-include sphinx_rtd_theme *.woff
 recursive-include sphinx_rtd_theme *.woff2
 recursive-include sphinx_rtd_theme/locale *.pot *.po *.mo
-prune build
+recursive-include tests *.py
+recursive-include tests *.rst
+prune build

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "sphinx-rtd-theme",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "homepage": "https://github.com/rtfd/sphinx_rtd_theme",
   "authors": [
     "Dave Snider, Read the Docs, Inc. & contributors <dev@readthedocs.org>"

docs/changelog.rst

@@ -1,4 +1,3 @@
-
 *********
 Changelog
 *********
@@ -13,6 +12,33 @@ New Features
 * Added i18n support using Babel
 * Added Translation Guide documentation
 
+Fixes
+-----
+
+Other Changes
+--------------
+
+* Add the ``navigation`` template block around the navigation area.
+
+0.4.3
+======
+
+:Date: Feb 12, 2019
+
+New Features
+-------------
+
+Fixes
+-----
+
+* Fix scrolling to active item in sidebar on load (#214)
+* Style caption link for code and literal blocks
+* Fix inconsistent font size and line height for autodoc "raises" and "returns" (#267)
+* Fix last_updated notice appearing in same line as copyright notice (#704)
+
+
+Other Changes
+--------------
 
 v0.4.2
 ======

docs/conf.py

@@ -1,37 +1,25 @@
 # -*- coding: utf-8 -*-
-#
-# Sphinx RTD theme demo documentation build configuration file, created by
-# sphinx-quickstart on Sun Nov  3 11:56:36 2013.
-#
-# This file is executed with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
 
 import sys
 import os
-
+import re
 
 sys.path.append(os.path.abspath('..'))
 sys.path.append(os.path.abspath('./demo/'))
 
+from sphinx.locale import _
+
 from sphinx_rtd_theme import __version__
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
 
-# -- General configuration -----------------------------------------------------
+project = u'Read the Docs Sphinx Theme'
+slug = re.sub(r'\W+', '-', project.lower())
+version = __version__
+release = __version__
+author = u'Dave Snider, Read the Docs, Inc. & contributors'
+copyright = author
+language = 'en'
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.autodoc',
@@ -41,223 +29,65 @@ extensions = [
     'sphinx_rtd_theme',
 ]
 
-# Do not warn about external images (status badges in README.rst)
-suppress_warnings = ['image.nonlocal_uri']
-
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
-
-# The suffix of source filenames.
 source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'Read the Docs Sphinx Theme'
-copyright = u'Dave Snider, Read the Docs, Inc. & contributors'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = __version__
-# The full version, including alpha/beta/rc tags.
-release = __version__
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-language = 'en'
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
 exclude_patterns = []
 
-# The reST default role (used for this markup: `text`) to use for all documents.
+master_doc = 'index'
-#default_role = None
+suppress_warnings = ['image.nonlocal_uri']
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'default'
 
-# A list of ignored prefixes for module index sorting.
+intersphinx_mapping = {
-#modindex_common_prefix = []
+    'rtd': ('https://docs.readthedocs.io/en/latest/', None),
+    'sphinx': ('http://www.sphinx-doc.org/en/stable/', None),
+}
 
-intersphinx_mapping = {'rtd': ('https://docs.readthedocs.io/en/latest/', None)}
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
 html_theme = 'sphinx_rtd_theme'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
 html_theme_options = {
     'logo_only': True
 }
-
-# Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ["../.."]
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
 html_logo = "demo/static/logo-wordmark-light.svg"
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
 html_show_sourcelink = True
 
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+htmlhelp_basename = slug
-#html_show_sphinx = True
 
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'SphinxRTDthemedemodoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'SphinxRTDthemedemo.tex', u'Sphinx RTD theme demo Documentation',
+  ('index', '{0}.tex'.format(slug), project, author, 'manual'),
-   u'Dave Snider, Read the Docs, Inc. & contributors', 'manual'),
 ]
 
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'sphinxrtdthemedemo', u'Sphinx RTD theme demo Documentation',
+    ('index', slug, project, [author], 1)
-     [u'Dave Snider, Read the Docs, Inc. & contributors'], 1)
 ]
 
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output ------------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'SphinxRTDthemedemo', u'Sphinx RTD theme demo Documentation',
+  ('index', slug, project, author, slug, project, 'Miscellaneous'),
-   u'Dave Snider, Read the Docs, Inc. & contributors', 'SphinxRTDthemedemo',
-   'One line description of project.', 'Miscellaneous'),
 ]
 
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
 
-# If false, no module index is generated.
+# Extensions to theme docs
-#texinfo_domain_indices = True
+def setup(app):
+    from sphinx.domains.python import PyField
+    from sphinx.util.docfields import Field
 
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
+    app.add_object_type(
-#texinfo_show_urls = 'footnote'
+        'confval',
+        'confval',
+        objname='configuration value',
+        indextemplate='pair: %s; configuration value',
+        doc_field_types=[
+            PyField(
+                'type',
+                label=_('Type'),
+                has_arg=False,
+                names=('type',),
+                bodyrolename='class'
+            ),
+            Field(
+                'default',
+                label=_('Default'),
+                has_arg=False,
+                names=('default',),
+            ),
+        ]
+    )

docs/configuring.rst

@@ -1,30 +1,26 @@
-
 *************
 Configuration
 *************
 
-You can configure different parts of the theme.
+Theme options
+=============
 
-Project-wide Configuration
+The following options can be defined in your project's ``conf.py`` file, using
-==========================
+the :confval:`html_theme_options <sphinx:html_theme_options>` configuration option.
 
-HTML Theme Options
+For example:
-------------------
-
-The theme's project-wide options are defined in the ``sphinx_rtd_theme/theme.conf``
-file of this repository, and can be defined in your project's ``conf.py`` via
-``html_theme_options``. For example:
 
 .. code:: python
 
     html_theme_options = {
         'canonical_url': '',
-        'analytics_id': '',
+        'analytics_id': 'UA-XXXXXXX-1',  #  Provided by Google in your dashboard
         'logo_only': False,
         'display_version': True,
         '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,
@@ -33,76 +29,198 @@ file of this repository, and can be defined in your project's ``conf.py`` via
         'titles_only': False
     }
 
-The following options are available:
+Table of contents options
+-------------------------
 
-Base options
+The following options change how :rst:dir:`sphinx:toctree` directives generate
-~~~~~~~~~~~~
+documentation navigation.
 
-* ``canonical_url`` String. This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__
+.. confval:: collapse_navigation
-  to let search engines know they should give higher ranking to latest version of the docs.
-  The url points to the root of the documentation and requires a trailing slash.
-* ``analytics_id`` String. Change the Google Analytics ID that is included on pages.
-* ``display_version`` Bool. With this disabled, the version number isn't shown at the top of the sidebar.
-* ``prev_next_buttons_location`` String. can take the value ``bottom``, ``top``, ``both`` , or ``None``
-  and will display the "Next" and "Previous" buttons accordingly.
-* ``style_external_links`` Bool. Add an icon next to external links. Defaults to ``False``.
-* ``vcs_pageview_mode`` String. Changes how to view files when using `display_github`, `display_gitlab`, etc.
-  When using Github or Gitlab this can be: `blob` (default), `edit`, or `raw`,
-  on Bitbucket, this can be either: `view` (default) or `edit`.
 
-TOC Options
+    :type: boolean
-~~~~~~~~~~~
+    :default: ``True``
 
-These effect how we display the Table of Contents in the side bar. You can read more about them here: http://www.sphinx-doc.org/en/stable/templating.html#toctree
+    With this enabled, navigation entries are not expandable -- the ``[+]``
+    icons next to each entry are removed.
 
-* ``collapse_navigation`` Bool. With this enabled, you will lose the ``[+]`` drop downs next to each section in the sidebar.
+.. confval:: sticky_navigation
-* ``sticky_navigation`` Bool. This causes the sidebar to scroll with the main page content as you scroll the page.
+
-* ``navigation_depth`` Int. Indicate the max depth of the tree; by default, 4 levels are included;
+    :type: boolean
-  set it to -1 to allow unlimited depth.
+    :default: ``True``
-* ``includehidden`` Bool. Specifies if the sidebar includes toctrees marked with the ``:hidden:`` option
+
-* ``titles_only`` Bool. If True, removes headers within a page from the sidebar.
+    Scroll the navigation with the main page content as you scroll the page.
+
+.. confval:: navigation_depth
+
+    :type: integer
+    :default: ``4``
+
+    The maximum depth of the table of contents tree. Set
+    this to ``-1`` to allow unlimited depth.
+
+.. confval:: includehidden
+
+    :type: boolean
+    :default: ``True``
+
+    Specifies if the navigation includes hidden table(s) of contents -- that is,
+    any :rst:dir:`sphinx:toctree` directive that is marked with the ``:hidden:``
+    option.
+
+.. confval:: titles_only
+
+    :type: boolean
+    :default: False
+
+    When enabled, page subheadings are not included in the
+    navigation.
 
 .. note::
-   
+    Setting :confval:`collapse_navigation` to ``False`` and using a high value
-   Setting ``collapse_navigation`` to False and using a high ``navigation_depth``
+    for :confval:`navigation_depth` on projects with many files and a deep file
-   can cause projects with many files and a deep file structure to generate HTML files
+    structure can cause long compilation times and can result in HTML files that
-   that are significantly larger in file size and much longer compilation times.
+    are significantly larger in file size.
+
+.. _table of contents configuration options: http://www.sphinx-doc.org/en/stable/templating.html#toctree
 
 
-HTML Context Options
+..
---------------------
+    TODO
-
+    .
-TODO.
+    HTML context options
+    ~~~~~~~~~~~~~~~~~~~~
 
 
-Page-level Configuration
+Miscellaneous options
-========================
+---------------------
 
-Pages support metadata that changes how the theme renders.
+.. confval:: analytics_id
-You can currently add the following:
 
-* ``:github_url:`` This will force the "Edit on GitHub" to the configured URL
+    :type: string
-* ``:bitbucket_url:`` This will force the "Edit on Bitbucket" to the configured URL
+
-* ``:gitlab_url:`` This will force the "Edit on GitLab" to the configured URL
+    Change the Google Analytics ID that is included on pages.
+
+    .. warning::
+        This configuration option is not yet used.
+
+.. confval:: canonical_url
+
+    :type: URL
+
+    This will specify a `canonical URL`_ meta link element to tell search
+    engines which URL should be ranked as the primary URL for your
+    documentation. This is important if you have multiple URLs that your
+    documentation is available through. The URL points to the root path of the
+    documentation and requires a trailing slash.
+
+.. confval:: display_version
+
+    :type: boolean
+    :default: ``True``
+
+    If ``True``, the version number is shown at the top of the sidebar.
+
+.. confval:: logo_only
+
+    :type: boolean
+    :default: ``False``
+
+    Only display the logo image, do not display the project name at the top of
+    the sidebar
+
+.. confval:: prev_next_buttons_location
+
+    :type: string
+    :default: ``bottom``
+
+    Location to display :guilabel:`Next` and :guilabel:`Previous` buttons. This
+    can be either ``bottom``, ``top``, ``both`` , or ``None``.
+
+.. confval:: style_external_links
+
+    :type: boolean
+    :default: ``False``
+
+    Add an icon next to external links.
+
+.. confval:: vcs_pageview_mode
+
+    :type: string
+    :default: ``blob`` or ``view``
+
+    Changes how to view files when using ``display_github``, ``display_gitlab``,
+    etc.  When using GitHub or GitLab this can be: ``blob`` (default), ``edit``,
+    or ``raw``. On Bitbucket, this can be either: ``view`` (default) or
+    ``edit``.
+
+.. confval:: style_nav_header_background
+
+    :type: string
+    :default: ``#2980B9``
+
+    Changes the background of the search area in the navigation bar. The value
+    can be anything valid in a CSS `background` property. 
+
+.. _canonical URL: https://en.wikipedia.org/wiki/Canonical_link_element
 
 
-How the Table of Contents builds
+File-wide metadata
-================================
+==================
 
-Currently the left menu will build based upon any ``toctree(s)`` defined in your ``index.rst`` file.
+The following options can be used as :ref:`file-wide metadata
-It outputs 2 levels of depth, which should give your visitors a high level of access to your
+<sphinx:metadata>`:
-docs. If no toctrees are set the theme reverts to sphinx's usual local toctree.
 
-It's important to note that if you don't follow the same styling for your rST headers across
+.. confval:: github_url
-your documents, the toctree will misbuild, and the resulting menu might not show the correct
-depth when it renders.
 
-Also note that by default the table of contents is set with ``includehidden=True``. This allows you
+    Force the :guilabel:`Edit on GitHub` button to use the configured URL.
-to set a hidden toc in your index file with the `:hidden: <hidden_>`_ property that will allow you
-to build a toc without it rendering in your index.
 
-By default, the navigation will "stick" to the screen as you scroll. However if your toc
+.. confval:: bitbucket_url
-is vertically too large, it will revert to static positioning. To disable the sticky nav
-altogether change the setting in ``conf.py``.
 
-.. _hidden: http://sphinx-doc.org/markup/toctree.html
+    Force the :guilabel:`Edit on Bitbucket` button to use the configured URL.
+
+.. confval:: gitlab_url
+
+    Force the :guilabel:`Edit on GitLab` button to use the configured URL.
+
+
+Other configuration
+===================
+
+Adding a logo
+-------------
+
+Using the Sphinx standard option :py:confval:`html_logo <sphinx:html_logo>`,
+you can set an image file to be used as a logo at the top of the sidebar. The
+theme option :py:confval:`logo_only` also allows for *only* the logo to be shown
+at the top of the sidebar.
+
+Adding custom CSS or Javascript
+-------------------------------
+
+Adding custom CSS or Javascript can help you alter the look and feel of this
+theme without forking the theme for local use.
+
+In order to add custom CSS or Javascript without disrupting the existing theme
+files, you can :doc:`add files to be included in your documentation output
+<rtd:guides/adding-custom-css>`.
+
+How the table of contents displays
+==================================
+
+Currently the left menu will build based upon any ``toctree`` directives defined
+in your source files.  It outputs 4 levels of depth by default, to allow for
+quick navigation through topics. If no TOC trees are defined, Sphinx's default
+behavior is to use the page headings instead.
+
+It's important to note that if you don't follow the same styling for your reST
+headings across your documents, the TOC tree will build incorrectly, and the
+resulting menu might not show the correct depth when it renders.
+
+Also note that by default the table of contents is set with
+``includehidden=True``. This allows you to set a hidden TOC in your index file
+with the :ref:`:hidden: <sphinx:toctree-directive>` property that will allow you
+to build a TOC without it rendering in your index.
+
+By default, the navigation will "stick" to the screen as you scroll. However if
+your TOC is not tall enough, it will revert to static positioning. To disable the
+sticky navigation altogether, change the :confval:`sticky_navigation` theme option.

docs/contributing.rst

@@ -13,7 +13,7 @@ of a front-end developer (vs. that of a python developer). That means installing
 .. seealso::
 
    If you are unsure of appropriate actions to take while interacting with our
-   community please read our :doc:`Code of Conduct <rtd:/code-of-conduct>`.
+   community please read our :doc:`Code of Conduct <rtd:code-of-conduct>`.
 
 
 Set up your environment
@@ -87,7 +87,3 @@ you should do the following:
         $ rm -rf dist/
         $ python setup.py sdist bdist_wheel
         $ twine upload --sign --identity security@readthedocs.org dist/*
-
-#. In the ``readthedocs.org`` repo, edit the ``bower.json`` file to point at the correct version
-   (``sphinx-rtd-theme": "https://github.com/rtfd/sphinx-rtd-theme.git#$NEW_VERSION"``).
-#. In the ``readthedocs.org`` repo, run ``gulp build`` to update the distributed theme files.

docs/make.bat

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

js/theme.js

@@ -152,6 +152,7 @@ function ThemeNav () {
                 link.closest('li.toctree-l2').addClass('current');
                 link.closest('li.toctree-l3').addClass('current');
                 link.closest('li.toctree-l4').addClass('current');
+                link[0].scrollIntoView();
             }
         }
         catch (err) {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "sphinx_rtd_theme",
   "main": "js/theme.js",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "private": true,
   "devDependencies": {
     "bower": "^1.8.4",

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

sass/_theme_layout.sass

@@ -31,15 +31,16 @@ html
   width: $nav-desktop-width
 
   header, p.caption
+    color: $nav-caption
     height: $base-font-size * 2
     display: inline-block
     line-height: $base-font-size * 2
     padding: 0 $gutter
-    margin-bottom: 0
+    margin: $base-line-height / 2 0 0 0
     display: block
     font-weight: bold
     text-transform: uppercase
-    font-size: 80%
+    font-size: 85%
     white-space: nowrap
 
   ul
@@ -362,6 +363,8 @@ footer
     color: $text-medium
     font-size: 90%
 
+.genindextable li > ul
+    margin-left: $base-line-height
 
 +media($tablet)
   .wy-body-for-nav

sass/_theme_rst.sass

@@ -95,6 +95,13 @@
     font-size: 12px
     line-height: 1.4
 
+  .code-block-caption
+    font-style: italic
+    font-size: 85%
+    line-height: 1
+    padding: 1em 0
+    text-align: center
+
   @media print
     .codeblock, div[class^='highlight'], div[class^='highlight'] pre
       white-space: pre-wrap
@@ -102,6 +109,9 @@
   // These are the various note pullouts that sphinx applies
   .note, .attention, .caution, .danger, .error, .hint, .important, .tip, .warning, .seealso, .admonition-todo, .admonition
     @extend .wy-alert
+    // These block elements are unsuitable for having floating objects next
+    // to them
+    clear: both
     .last
       margin-bottom: 0
   .admonition-title
@@ -165,7 +175,7 @@
     @extend h2
 
   // This is the #href that shows up on hover. Sphinx's is terrible so I hack it away.
-  h1, h2, h3, h4, h5, h6, dl dt, p.caption, table > caption
+  h1, h2, h3, h4, h5, h6, dl dt, p.caption, table > caption, .code-block-caption
     .headerlink
       visibility: hidden
       font-size: 14px
@@ -263,6 +273,9 @@
     border: none
     td
       border: none
+      p
+        font-size: inherit
+        line-height: inherit
     td > strong
       display: inline-block
     .field-name

sass/_theme_variables.sass

@@ -51,6 +51,7 @@ $nav-link-color:                      $blue
 $nav-link-color-visited:              $purple
 $nav-link-color-hover:                lighten($nav-link-color, 6%) !default
 $nav-link-color-alt:                  hsl(33, 100%, 51%)
+$nav-caption:                         lighten($blue, 15%)
 
 // Sidebar colors
 $sidebar-background-color:            $table-stripe-color

setup.py

@@ -25,7 +25,7 @@ setup(
         '*.html',
         'static/css/*.css',
         'static/js/*.js',
-        'static/font/*.*'
+        'static/fonts/*.*'
     ]},
     include_package_data=True,
     # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package

sphinx_rtd_theme/__init__.py

@@ -6,7 +6,8 @@ From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
 from os import path
 import sphinx
 
-__version__ = '0.4.2'
+
+__version__ = '0.4.3.dev0'
 __version_full__ = __version__
 
 
@@ -15,6 +16,7 @@ def get_html_theme_path():
     cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
     return cur_dir
 
+
 # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
 def setup(app):
     app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))

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 %}
@@ -35,7 +35,9 @@
         {% trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
       </span>
     {%- elif last_updated %}
-      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+      <span class="lastupdated">
+        {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+      </span>
     {%- endif %}
 
     </p>

sphinx_rtd_theme/layout.html

@@ -28,18 +28,42 @@
     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
   {% endif %}
 
-  {# CSS #}
+  {# JAVASCRIPTS #}
-
+  <script type="text/javascript" src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
-  {# OPENSEARCH #}
+  {%- if not embedded %}
-  {% 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 #}
-    {% if use_opensearch %}
+    {% if sphinx_version >= "1.8.0" %}
-      <link rel="search" type="application/opensearchdescription+xml"
+      <script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
-            title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
+      {%- for scriptfile in script_files %}
-            href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+        {{ js_tag(scriptfile) }}
+      {%- endfor %}
+    {% else %}
+      <script type="text/javascript">
+          var DOCUMENTATION_OPTIONS = {
+              URL_ROOT:'{{ url_root }}',
+              VERSION:'{{ release|e }}',
+              LANGUAGE:'{{ language }}',
+              COLLAPSE_INDEX:false,
+              FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
+              HAS_SOURCE:  {{ has_source|lower }},
+              SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
+          };
+      </script>
+      {%- for scriptfile in script_files %}
+        <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
+      {%- endfor %}
     {% endif %}
+    <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
 
-  {% endif %}
+    {# OPENSEARCH #}
+    {%- if use_opensearch %}
+    <link rel="search" type="application/opensearchdescription+xml"
+          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
+          href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+    {%- endif %}
+  {%- endif %}
 
+  {# CSS #}
   <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
   <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
   {%- for css in css_files %}
@@ -49,6 +73,7 @@
   <link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
     {%- endif %}
   {%- endfor %}
+
   {%- for cssfile in extra_css_files %}
     <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
   {%- endfor %}
@@ -74,21 +99,16 @@
     {%- endif %}
   {%- endblock %}
   {%- block extrahead %} {% endblock %}
-
-  {# Keep modernizr in head - http://modernizr.com/docs/#installing #}
-  <script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
-
 </head>
 
 <body class="wy-body-for-nav">
 
   {% 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 %}
@@ -122,6 +142,7 @@
           {% endblock %}
         </div>
 
+        {% block navigation %}
         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
           {% block menu %}
             {#
@@ -142,6 +163,7 @@
             {% endif %}
           {% endblock %}
         </div>
+        {% endblock %}
       </div>
     </nav>
 
@@ -186,41 +208,29 @@
   </div>
   {% include "versions.html" %}
 
-  {% 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 #}
-    {% if sphinx_version >= "1.8.0" %}
-      <script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
-      {%- for scriptfile in script_files %}
-        {{ js_tag(scriptfile) }}
-      {%- endfor %}
-    {% else %}
-      <script type="text/javascript">
-          var DOCUMENTATION_OPTIONS = {
-              URL_ROOT:'{{ url_root }}',
-              VERSION:'{{ release|e }}',
-              LANGUAGE:'{{ language }}',
-              COLLAPSE_INDEX:false,
-              FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
-              HAS_SOURCE:  {{ has_source|lower }},
-              SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
-          };
-      </script>
-      {%- for scriptfile in script_files %}
-        <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
-      {%- endfor %}
-    {% endif %}
-
-  {% endif %}
-
-  <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
-
   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
       });
   </script>
 
+  {# Do not conflict with RTD insertion of analytics script #}
+  {% if not READTHEDOCS %}
+    {% if theme_analytics_id %}
+    <!-- Theme Analytics -->
+    <script>
+    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+    })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+    ga('create', '{{ theme_analytics_id }}', 'auto');
+    ga('send', 'pageview');
+    </script>
+
+    {% endif %}
+  {% endif %}
+
   {%- block footer %} {% endblock %}
 
 </body>

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;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}}
+.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%;overflow-y:scroll}.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;max-height:90%}.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,3 +1,3 @@
-/* sphinx_rtd_theme version 0.4.2 | MIT license */
+/* sphinx_rtd_theme version 0.4.3 | MIT license */
-/* Built 20181005 13:10 */
+/* Built 20190212 16:02 */
-require=function r(s,a,l){function c(e,n){if(!a[e]){if(!s[e]){var i="function"==typeof require&&require;if(!n&&i)return i(e,!0);if(u)return u(e,!0);var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[e]={exports:{}};s[e][0].call(o.exports,function(n){return c(s[e][1][n]||n)},o,o.exports,r,s,a,l)}return a[e].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;void 0===e&&(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"]);
+require=function r(s,a,l){function c(e,n){if(!a[e]){if(!s[e]){var i="function"==typeof require&&require;if(!n&&i)return i(e,!0);if(u)return u(e,!0);var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[e]={exports:{}};s[e][0].call(o.exports,function(n){return c(s[e][1][n]||n)},o,o.exports,r,s,a,l)}return a[e].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;void 0===e&&(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"),i[0].scrollIntoView())}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"]);

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 =