diff -Nru sphinx-rtd-theme-0.5.0+dfsg/.circleci/config.yml sphinx-rtd-theme-0.5.1+dfsg/.circleci/config.yml --- sphinx-rtd-theme-0.5.0+dfsg/.circleci/config.yml 1970-01-01 00:00:00.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/.circleci/config.yml 2021-01-04 22:13:31.000000000 +0000 @@ -0,0 +1,54 @@ +version: 2.1 + +commands: + run-tox: + description: "Run tox" + parameters: + version: + type: string + steps: + - checkout + - run: pip install --user tox + - run: tox -e "<>-sphinx{16,17,18,20,21,22,23,24,30,31,32}" + +jobs: + py27: + docker: + - image: 'cimg/python:2.7' + steps: + - run-tox: + version: py27 + py36: + docker: + - image: 'cimg/python:3.6' + steps: + - run-tox: + version: py36 + py37: + docker: + - image: 'cimg/python:3.7' + steps: + - run-tox: + version: py37 + py38: + docker: + - image: 'cimg/python:3.8' + steps: + - run-tox: + version: py38 + py39: + docker: + - image: 'cimg/python:3.9' + steps: + - run-tox: + version: py39 + +workflows: + version: 2 + tests: + jobs: + - py39 + - py38 + - py37 + - py36 + - py27 diff -Nru sphinx-rtd-theme-0.5.0+dfsg/debian/changelog sphinx-rtd-theme-0.5.1+dfsg/debian/changelog --- sphinx-rtd-theme-0.5.0+dfsg/debian/changelog 2020-08-29 07:45:16.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/debian/changelog 2021-01-05 18:38:24.000000000 +0000 @@ -1,8 +1,18 @@ -sphinx-rtd-theme (0.5.0+dfsg-1ubuntu1) groovy; urgency=medium +sphinx-rtd-theme (0.5.1+dfsg-1) unstable; urgency=medium - * Remove node-html5shiv dependency, it is not in main. + [ Ondřej Nový ] + * d/control: Update Maintainer field with new Debian Python Team + contact address. + * d/control: Update Vcs-* fields with new Debian Python Team Salsa + layout. - -- Dmitry Shachnev Sat, 29 Aug 2020 10:45:16 +0300 + [ Dmitry Shachnev ] + * New upstream release. + * Remove node-html5shiv dependency, it was only needed for IE 8. + - Add html5shiv{,-printshiv}.min.js as dummy empty files. + * Bump Standards-Version to 4.5.1, no changes needed. + + -- Dmitry Shachnev Tue, 05 Jan 2021 21:38:24 +0300 sphinx-rtd-theme (0.5.0+dfsg-1) unstable; urgency=medium diff -Nru sphinx-rtd-theme-0.5.0+dfsg/debian/control sphinx-rtd-theme-0.5.1+dfsg/debian/control --- sphinx-rtd-theme-0.5.0+dfsg/debian/control 2020-08-29 07:45:16.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/debian/control 2021-01-05 18:38:24.000000000 +0000 @@ -1,8 +1,7 @@ Source: sphinx-rtd-theme Section: python Priority: optional -Maintainer: Ubuntu Developers -XSBC-Original-Maintainer: Debian Python Modules Team +Maintainer: Debian Python Team Uploaders: Dmitry Shachnev Build-Depends: debhelper-compat (= 13), dh-python, @@ -15,10 +14,10 @@ python3-sphinx, ruby-sass, woff2 -Standards-Version: 4.5.0 +Standards-Version: 4.5.1 Homepage: https://github.com/readthedocs/sphinx_rtd_theme -Vcs-Git: https://salsa.debian.org/python-team/modules/sphinx-rtd-theme.git -Vcs-Browser: https://salsa.debian.org/python-team/modules/sphinx-rtd-theme +Vcs-Git: https://salsa.debian.org/python-team/packages/sphinx-rtd-theme.git +Vcs-Browser: https://salsa.debian.org/python-team/packages/sphinx-rtd-theme Package: sphinx-rtd-theme-common Architecture: all diff -Nru sphinx-rtd-theme-0.5.0+dfsg/debian/patches/remove-html5shiv.patch sphinx-rtd-theme-0.5.1+dfsg/debian/patches/remove-html5shiv.patch --- sphinx-rtd-theme-0.5.0+dfsg/debian/patches/remove-html5shiv.patch 2020-08-29 07:45:16.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/debian/patches/remove-html5shiv.patch 2021-01-05 18:38:24.000000000 +0000 @@ -1,5 +1,5 @@ From: Dmitry Shachnev -Date: Sat, 29 Aug 2020 10:43:16 +0300 +Date: Wed, 16 Dec 2020 20:50:55 +0300 Subject: Remove html5shiv dependency --- @@ -7,10 +7,10 @@ 1 file changed, 3 deletions(-) diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html -index 246d211..a17257e 100644 +index ca16d16..967fe29 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html -@@ -45,9 +45,6 @@ +@@ -51,9 +51,6 @@ {# JAVASCRIPTS #} {%- block scripts %} diff -Nru sphinx-rtd-theme-0.5.0+dfsg/debian/rules sphinx-rtd-theme-0.5.1+dfsg/debian/rules --- sphinx-rtd-theme-0.5.0+dfsg/debian/rules 2020-08-29 07:45:16.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/debian/rules 2021-01-05 18:38:24.000000000 +0000 @@ -46,8 +46,14 @@ dh_link --remaining-packages # To make the created symlinks relative # Dummy empty files, to make sure that packages built against older # sphinx-rtd-theme do not have dangling symlinks after upgrade. + # Inconsolata-*.ttf: used up to version 0.2.4-1, present in Stretch. touch debian/sphinx-rtd-theme-common/usr/share/sphinx_rtd_theme/static/fonts/Inconsolata-Bold.ttf touch debian/sphinx-rtd-theme-common/usr/share/sphinx_rtd_theme/static/fonts/Inconsolata-Regular.ttf + # RobotoSlab-*.ttf: used up to version 0.4.3+dfsg-1, present in Stretch and Buster. touch debian/sphinx-rtd-theme-common/usr/share/sphinx_rtd_theme/static/fonts/RobotoSlab-Bold.ttf touch debian/sphinx-rtd-theme-common/usr/share/sphinx_rtd_theme/static/fonts/RobotoSlab-Regular.ttf + # modernizr.min.js: used up to version 0.4.3+dfsg-3, present in Stretch and Buster. touch debian/sphinx-rtd-theme-common/usr/share/sphinx_rtd_theme/static/js/modernizr.min.js + # html5shiv*.js: used only in version 0.5.0+dfsg-1, not present in any stable release. + touch debian/sphinx-rtd-theme-common/usr/share/sphinx_rtd_theme/static/js/html5shiv-printshiv.min.js + touch debian/sphinx-rtd-theme-common/usr/share/sphinx_rtd_theme/static/js/html5shiv.min.js diff -Nru sphinx-rtd-theme-0.5.0+dfsg/docs/changelog.rst sphinx-rtd-theme-0.5.1+dfsg/docs/changelog.rst --- sphinx-rtd-theme-0.5.0+dfsg/docs/changelog.rst 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/docs/changelog.rst 2021-01-04 22:13:31.000000000 +0000 @@ -5,6 +5,36 @@ master ====== +v0.5.1 +====== + +:Date: January 4, 2021 + +Fixes +----- + +* Set ``url_root`` properly on index (#1025) +* Do not load ``language_data.js`` in non-search pages (#1021) +* Hide the search box on any ``singlehtml`` like builder (#975) +* Fix ``vcs_pageview_mode`` template parameter (#1010) +* Mark nex/prev icons as aria-hidden (#1007) +* Use well-formed XML syntax (#1006) +* Footer: show both ``commit`` and ``last_updated`` if available (#897) +* Search page: don't show "edit on" links (#935) + +New Features +------------ + +* New theme option to enable anonymous ip addresses when using Google Analytics (#889) + +Other Changes +------------- + +* The ``canonical_url`` option was deprecated in favor of Sphinx's ``html_baseurl`` (#1003) +* Add ``contentinfo`` block to ``footer.html`` template (#896) +* Make Copyright template match sphinx's basic (#933) +* Packaging: include ``bin/preinstall.js`` (#1005) + v0.5.0 ====== diff -Nru sphinx-rtd-theme-0.5.0+dfsg/docs/configuring.rst sphinx-rtd-theme-0.5.1+dfsg/docs/configuring.rst --- sphinx-rtd-theme-0.5.0+dfsg/docs/configuring.rst 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/docs/configuring.rst 2021-01-04 22:13:31.000000000 +0000 @@ -13,8 +13,8 @@ .. code:: python html_theme_options = { - 'canonical_url': '', 'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard + 'analytics_anonymize_ip': False, 'logo_only': False, 'display_version': True, 'prev_next_buttons_location': 'bottom', @@ -101,6 +101,13 @@ If specified, Google Analytics' javascript is included in your pages. Set the value to the ID provided to you by google (like ``UA-XXXXXXX``). +.. confval:: analytics_anonymize_ip + + :type: boolean + :default: ``False`` + + Anonymize visitor IP addresses in Google Analytics. + .. confval:: canonical_url :type: URL @@ -111,6 +118,12 @@ documentation is available through. The URL points to the root path of the documentation and requires a trailing slash. + .. deprecated:: 0.6.0 + + Use :confval:`sphinx:html_baseurl` instead. + + .. _canonical URL: https://en.wikipedia.org/wiki/Canonical_link_element + .. confval:: display_version :type: boolean @@ -157,10 +170,7 @@ :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 - + can be anything valid in a CSS `background` property. File-wide metadata ================== diff -Nru sphinx-rtd-theme-0.5.0+dfsg/docs/conf.py sphinx-rtd-theme-0.5.1+dfsg/docs/conf.py --- sphinx-rtd-theme-0.5.0+dfsg/docs/conf.py 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/docs/conf.py 2021-01-04 22:13:31.000000000 +0000 @@ -26,8 +26,8 @@ project = u'Read the Docs Sphinx Theme' slug = re.sub(r'\W+', '-', project.lower()) -version = '0.5.0' -release = '0.5.0' +version = '0.5.1' +release = '0.5.1' author = u'Dave Snider, Read the Docs, Inc. & contributors' copyright = author language = 'en' diff -Nru sphinx-rtd-theme-0.5.0+dfsg/MANIFEST.in sphinx-rtd-theme-0.5.1+dfsg/MANIFEST.in --- sphinx-rtd-theme-0.5.0+dfsg/MANIFEST.in 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/MANIFEST.in 2021-01-04 22:13:31.000000000 +0000 @@ -1,6 +1,7 @@ include *.txt include babel.cfg include LICENSE +include bin/preinstall.js recursive-include sphinx_rtd_theme *.conf recursive-include sphinx_rtd_theme *.css recursive-include sphinx_rtd_theme *.eot diff -Nru sphinx-rtd-theme-0.5.0+dfsg/package.json sphinx-rtd-theme-0.5.1+dfsg/package.json --- sphinx-rtd-theme-0.5.0+dfsg/package.json 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/package.json 2021-01-04 22:13:31.000000000 +0000 @@ -1,8 +1,7 @@ { "name": "sphinx_rtd_theme", "main": "js/theme.js", - "version": "0.5.0", - "private": true, + "version": "0.5.1", "scripts": { "dev": "webpack-dev-server --open --config webpack.dev.js", "build": "webpack --config webpack.prod.js", diff -Nru sphinx-rtd-theme-0.5.0+dfsg/README.rst sphinx-rtd-theme-0.5.1+dfsg/README.rst --- sphinx-rtd-theme-0.5.0+dfsg/README.rst 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/README.rst 2021-01-04 22:13:31.000000000 +0000 @@ -5,9 +5,9 @@ .. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg :target: https://pypi.python.org/pypi/sphinx_rtd_theme :alt: Pypi Version -.. image:: https://travis-ci.org/readthedocs/sphinx_rtd_theme.svg?branch=master - :target: https://travis-ci.org/readthedocs/sphinx_rtd_theme +.. image:: https://circleci.com/gh/readthedocs/sphinx_rtd_theme.svg?style=svg :alt: Build Status + :target: https://circleci.com/gh/readthedocs/sphinx_rtd_theme .. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg :target: https://pypi.python.org/pypi/sphinx_rtd_theme/ :alt: License diff -Nru sphinx-rtd-theme-0.5.0+dfsg/.readthedocs.yml sphinx-rtd-theme-0.5.1+dfsg/.readthedocs.yml --- sphinx-rtd-theme-0.5.0+dfsg/.readthedocs.yml 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/.readthedocs.yml 2021-01-04 22:13:31.000000000 +0000 @@ -1,5 +1,9 @@ version: 2 + python: - version: 3.6 + version: 3 install: - requirements: docs/requirements.txt + +sphinx: + configuration: docs/conf.py diff -Nru sphinx-rtd-theme-0.5.0+dfsg/setup.cfg sphinx-rtd-theme-0.5.1+dfsg/setup.cfg --- sphinx-rtd-theme-0.5.0+dfsg/setup.cfg 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/setup.cfg 2021-01-04 22:13:31.000000000 +0000 @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.5.0 +current_version = 0.5.1 commit = false tag = false parse = (?P\d+)\.(?P\d+)\.(?P\d+)((?P[a-z]+)(?P\d+))? diff -Nru sphinx-rtd-theme-0.5.0+dfsg/setup.py sphinx-rtd-theme-0.5.1+dfsg/setup.py --- sphinx-rtd-theme-0.5.0+dfsg/setup.py 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/setup.py 2021-01-04 22:13:31.000000000 +0000 @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """`sphinx_rtd_theme` lives on `Github`_. -.. _github: https://github.com/rtfd/sphinx_rtd_theme +.. _github: https://github.com/readthedocs/sphinx_rtd_theme """ @@ -85,8 +85,8 @@ setup( name='sphinx_rtd_theme', - version='0.5.0', - url='https://github.com/rtfd/sphinx_rtd_theme/', + version='0.5.1', + url='https://github.com/readthedocs/sphinx_rtd_theme', license='MIT', author='Dave Snider, Read the Docs, Inc. & contributors', author_email='dev@readthedocs.org', diff -Nru sphinx-rtd-theme-0.5.0+dfsg/sphinx_rtd_theme/breadcrumbs.html sphinx-rtd-theme-0.5.1+dfsg/sphinx_rtd_theme/breadcrumbs.html --- sphinx-rtd-theme-0.5.0+dfsg/sphinx_rtd_theme/breadcrumbs.html 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/sphinx_rtd_theme/breadcrumbs.html 2021-01-04 22:13:31.000000000 +0000 @@ -24,6 +24,8 @@ {% set display_gitlab = True %} {% endif %} +{% set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %} +
    @@ -36,27 +38,27 @@ {% endblock %} {% block breadcrumbs_aside %}
  • - {% if hasdoc(pagename) %} - {% if display_github %} + {% if hasdoc(pagename) and display_vcs_links %} + {% if display_github %} {% if check_meta and 'github_url' in meta %} {{ _('Edit on GitHub') }} {% else %} - {{ _('Edit on GitHub') }} + {{ _('Edit on GitHub') }} {% endif %} {% elif display_bitbucket %} {% if check_meta and 'bitbucket_url' in meta %} {{ _('Edit on Bitbucket') }} {% else %} - {{ _('Edit on Bitbucket') }} + {{ _('Edit on Bitbucket') }} {% endif %} {% elif display_gitlab %} {% if check_meta and 'gitlab_url' in meta %} {{ _('Edit on GitLab') }} {% else %} - {{ _('Edit on GitLab') }} + {{ _('Edit on GitLab') }} {% endif %} {% elif show_source and source_url_prefix %} {{ _('View page source') }} @@ -71,10 +73,10 @@ {% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %} {% endif %} diff -Nru sphinx-rtd-theme-0.5.0+dfsg/sphinx_rtd_theme/footer.html sphinx-rtd-theme-0.5.1+dfsg/sphinx_rtd_theme/footer.html --- sphinx-rtd-theme-0.5.0+dfsg/sphinx_rtd_theme/footer.html 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/sphinx_rtd_theme/footer.html 2021-01-04 22:13:31.000000000 +0000 @@ -1,27 +1,25 @@
    - {% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %} + {%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %} - {% endif %} + {%- endif %}
    + {%- block contentinfo %}

    {%- if show_copyright %} {%- if hasdoc('copyright') %} - {% set path = pathto('copyright') %} - {% set copyright = copyright|e %} - © {% trans %}Copyright{% endtrans %} {{ copyright }} + {% trans path=pathto('copyright'), copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} {%- else %} - {% set copyright = copyright|e %} - © {% trans %}Copyright{% endtrans %} {{ copyright }} + {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} {%- endif %} {%- endif %} @@ -36,22 +34,24 @@ {# Translators: the phrase "revision" comes from Git, referring to a commit #} {% trans %}Revision{% endtrans %} {{ commit }}. - {%- elif last_updated %} + {%- endif %} + {%- if last_updated %} {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} {%- endif %}

    + {%- endblock %}
    {%- if show_sphinx %} - {% set sphinx_web = 'Sphinx' %} + {% set sphinx_web = 'Sphinx' %} {% set readthedocs_web = 'Read the Docs' %} {# Translators: the variable "sphinx_web" is a link to the Sphinx project documentation with the text "Sphinx" #} {% trans sphinx_web=sphinx_web, readthedocs_web=readthedocs_web %}Built with {{ sphinx_web }} using a{% endtrans %} {# Translators: "theme" refers to a theme for Sphinx, which alters the appearance of the generated documenation #} - {% trans %}theme{% endtrans %} + {% trans %}theme{% endtrans %} {# Translators: this is always used as "provided by Read the Docs", and should not imply Read the Docs is an author of the generated documentation. #} {% trans %}provided by {{ readthedocs_web }}{% endtrans %}. {%- endif %} @@ -59,4 +59,3 @@ {%- block extrafooter %} {% endblock %}
    - diff -Nru sphinx-rtd-theme-0.5.0+dfsg/sphinx_rtd_theme/__init__.py sphinx-rtd-theme-0.5.1+dfsg/sphinx_rtd_theme/__init__.py --- sphinx-rtd-theme-0.5.0+dfsg/sphinx_rtd_theme/__init__.py 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/sphinx_rtd_theme/__init__.py 2021-01-04 22:13:31.000000000 +0000 @@ -6,12 +6,21 @@ from os import path -import sphinx +from sphinx import version_info +from sphinx.locale import _ +try: + # Avaliable from Sphinx 1.6 + from sphinx.util.logging import getLogger +except ImportError: + from logging import getLogger -__version__ = '0.5.0' + +__version__ = '0.5.1' __version_full__ = __version__ +logger = getLogger(__name__) + def get_html_theme_path(): """Return list of HTML theme paths.""" @@ -19,16 +28,25 @@ return cur_dir +def config_initiated(app, config): + theme_options = config.html_theme_options or {} + if theme_options.get('canonical_url'): + logger.warning( + _('The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.') + ) + + # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package def setup(app): - if sphinx.version_info >= (1, 6, 0): + if version_info >= (1, 6, 0): # Register the theme that can be referenced without adding a theme path app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__))) - if sphinx.version_info >= (1, 8, 0): + if version_info >= (1, 8, 0): # Add Sphinx message catalog for newer versions of Sphinx # See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale') app.add_message_catalog('sphinx', rtd_locale_path) + app.connect('config-inited', config_initiated) return {'parallel_read_safe': True, 'parallel_write_safe': True} diff -Nru sphinx-rtd-theme-0.5.0+dfsg/sphinx_rtd_theme/layout.html sphinx-rtd-theme-0.5.1+dfsg/sphinx_rtd_theme/layout.html --- sphinx-rtd-theme-0.5.0+dfsg/sphinx_rtd_theme/layout.html 2020-06-17 15:58:25.000000000 +0000 +++ sphinx-rtd-theme-0.5.1+dfsg/sphinx_rtd_theme/layout.html 2021-01-04 22:13:31.000000000 +0000 @@ -12,9 +12,9 @@ - + {{ metatags }} - + {% block htmltitle %} {{ title|striptags|e }}{{ titlesuffix }} {% endblock %} @@ -38,11 +38,17 @@ {% if favicon %} {% endif %} - {# CANONICAL URL #} - {% if theme_canonical_url %} + + {# CANONICAL URL (deprecated) #} + {% if theme_canonical_url and not pageurl %} {% endif %} + {# CANONICAL URL #} + {%- if pageurl %} + + {%- endif %} + {# JAVASCRIPTS #} {%- block scripts %}