diff -Nru sphinx-rtd-theme-0.1.9/debian/changelog sphinx-rtd-theme-0.2.4/debian/changelog --- sphinx-rtd-theme-0.1.9/debian/changelog 2017-02-01 19:49:46.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/debian/changelog 2017-06-30 17:10:39.000000000 +0000 @@ -1,3 +1,19 @@ +sphinx-rtd-theme (0.2.4-1) unstable; urgency=medium + + * New upstream version 0.2.4. + * Update patches for the new release. + - Drop do-not-require-sphinx.patch, applied upstream. + - Drop sourcelink-suffix.patch, it was coming from upstream. + - Rebase theme-path.patch. + * Use HTTPS URL in Vcs-Git field. + * Update Homepage and Source URLs to the new upstream repository location. + * Bump Standards-Version to 4.0.0, no changes needed. + * Bump debhelper compatibility level to 10. + * Install README.rst in python3-sphinx-rtd-theme package. + * Upload to unstable. + + -- Dmitry Shachnev Fri, 30 Jun 2017 20:10:39 +0300 + sphinx-rtd-theme (0.1.9-2) experimental; urgency=medium * Set theme_path to /usr/share/sphinx_rtd_theme. diff -Nru sphinx-rtd-theme-0.1.9/debian/compat sphinx-rtd-theme-0.2.4/debian/compat --- sphinx-rtd-theme-0.1.9/debian/compat 2017-02-01 15:46:11.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/debian/compat 2017-06-30 17:10:39.000000000 +0000 @@ -1 +1 @@ -9 +10 diff -Nru sphinx-rtd-theme-0.1.9/debian/control sphinx-rtd-theme-0.2.4/debian/control --- sphinx-rtd-theme-0.1.9/debian/control 2017-02-01 19:43:28.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/debian/control 2017-06-30 17:10:39.000000000 +0000 @@ -3,11 +3,15 @@ Priority: optional Maintainer: Debian Python Modules Team Uploaders: Dmitry Shachnev -Build-Depends: python-setuptools, python-all (>= 2.7), debhelper (>= 9), - dh-python, python3-all, python3-setuptools -Standards-Version: 3.9.8 -Homepage: https://github.com/snide/sphinx_rtd_theme -Vcs-Git: git://anonscm.debian.org/python-modules/packages/sphinx-rtd-theme.git +Build-Depends: debhelper (>= 10), + dh-python, + python-all (>= 2.7), + python-setuptools, + python3-all, + python3-setuptools +Standards-Version: 4.0.0 +Homepage: https://github.com/rtfd/sphinx_rtd_theme +Vcs-Git: https://anonscm.debian.org/git/python-modules/packages/sphinx-rtd-theme.git Vcs-Browser: https://anonscm.debian.org/cgit/python-modules/packages/sphinx-rtd-theme.git X-Python-Version: >= 2.7 X-Python3-Version: >= 3.2 diff -Nru sphinx-rtd-theme-0.1.9/debian/copyright sphinx-rtd-theme-0.2.4/debian/copyright --- sphinx-rtd-theme-0.1.9/debian/copyright 2017-02-01 15:46:11.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/debian/copyright 2017-06-30 17:10:39.000000000 +0000 @@ -1,7 +1,7 @@ Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: Sphinx ReadTheDocs theme Upstream-Contact: Dave Snider -Source: https://github.com/snide/sphinx_rtd_theme +Source: https://github.com/rtfd/sphinx_rtd_theme Files: * Copyright: 2013 Dave Snider diff -Nru sphinx-rtd-theme-0.1.9/debian/patches/do-not-require-sphinx.patch sphinx-rtd-theme-0.2.4/debian/patches/do-not-require-sphinx.patch --- sphinx-rtd-theme-0.1.9/debian/patches/do-not-require-sphinx.patch 2017-02-01 15:46:11.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/debian/patches/do-not-require-sphinx.patch 1970-01-01 00:00:00.000000000 +0000 @@ -1,14 +0,0 @@ -Description: Do not require sphinx - Needed to avoid circular dependency with sphinx. It is replaced by a - Recommends. -Author: Sébastien Villemot -Bug: https://github.com/snide/sphinx_rtd_theme/issues/189 -Bug-Debian: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=783795 -Last-Update: 2015-05-06 ---- -This patch header follows DEP-3: http://dep.debian.net/deps/dep3/ ---- a/requirements.txt -+++ b/requirements.txt -@@ -1 +1 @@ --sphinx>=1.3 -+ diff -Nru sphinx-rtd-theme-0.1.9/debian/patches/series sphinx-rtd-theme-0.2.4/debian/patches/series --- sphinx-rtd-theme-0.1.9/debian/patches/series 2017-02-01 19:29:54.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/debian/patches/series 2017-06-30 17:10:39.000000000 +0000 @@ -1,3 +1 @@ -do-not-require-sphinx.patch theme-path.patch -sourcelink-suffix.patch diff -Nru sphinx-rtd-theme-0.1.9/debian/patches/sourcelink-suffix.patch sphinx-rtd-theme-0.2.4/debian/patches/sourcelink-suffix.patch --- sphinx-rtd-theme-0.1.9/debian/patches/sourcelink-suffix.patch 2017-02-01 19:32:17.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/debian/patches/sourcelink-suffix.patch 1970-01-01 00:00:00.000000000 +0000 @@ -1,30 +0,0 @@ -Description: add missing SOURCELINK_SUFFIX - Adds DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX which is expected by the - searchtools.js. -Origin: upstream, https://github.com/snide/sphinx_rtd_theme/commit/a5e0e304d30ed7aa -Last-Update: 2017-02-01 - ---- a/sphinx_rtd_theme/layout.html -+++ b/sphinx_rtd_theme/layout.html -@@ -167,7 +167,8 @@ - VERSION:'{{ release|e }}', - COLLAPSE_INDEX:false, - FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}', -- HAS_SOURCE: {{ has_source|lower }} -+ HAS_SOURCE: {{ has_source|lower }}, -+ SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}' - }; - - {%- for scriptfile in script_files %} ---- a/sphinx_rtd_theme/layout_old.html -+++ b/sphinx_rtd_theme/layout_old.html -@@ -91,7 +91,8 @@ - VERSION: '{{ release|e }}', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}', -- HAS_SOURCE: {{ has_source|lower }} -+ HAS_SOURCE: {{ has_source|lower }}, -+ SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}' - }; - - {%- for scriptfile in script_files %} diff -Nru sphinx-rtd-theme-0.1.9/debian/patches/theme-path.patch sphinx-rtd-theme-0.2.4/debian/patches/theme-path.patch --- sphinx-rtd-theme-0.1.9/debian/patches/theme-path.patch 2017-02-01 15:46:11.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/debian/patches/theme-path.patch 2017-06-30 17:10:39.000000000 +0000 @@ -1,11 +1,11 @@ Description: use /usr/share/ as theme path Author: Dmitry Shachnev Forwarded: not-needed -Last-Update: 2016-01-11 +Last-Update: 2017-06-20 --- a/sphinx_rtd_theme/__init__.py +++ b/sphinx_rtd_theme/__init__.py -@@ -13,5 +13,4 @@ +@@ -11,5 +11,4 @@ def get_html_theme_path(): """Return list of HTML theme paths.""" @@ -26,6 +26,6 @@ - 'static/font/*.*' - ]}, - include_package_data=True, - install_requires=open('requirements.txt').read().splitlines(), classifiers=[ - 'Development Status :: 3 - Alpha', + 'Development Status :: 5 - Production/Stable', + 'License :: OSI Approved :: MIT License', diff -Nru sphinx-rtd-theme-0.1.9/debian/python3-sphinx-rtd-theme.docs sphinx-rtd-theme-0.2.4/debian/python3-sphinx-rtd-theme.docs --- sphinx-rtd-theme-0.1.9/debian/python3-sphinx-rtd-theme.docs 1970-01-01 00:00:00.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/debian/python3-sphinx-rtd-theme.docs 2017-06-30 17:10:39.000000000 +0000 @@ -0,0 +1 @@ +README.rst diff -Nru sphinx-rtd-theme-0.1.9/PKG-INFO sphinx-rtd-theme-0.2.4/PKG-INFO --- sphinx-rtd-theme-0.1.9/PKG-INFO 2015-09-15 21:26:52.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/PKG-INFO 2017-03-06 23:34:36.000000000 +0000 @@ -1,8 +1,8 @@ Metadata-Version: 1.1 Name: sphinx_rtd_theme -Version: 0.1.9 -Summary: ReadTheDocs.org theme for Sphinx, 2013 version. -Home-page: https://github.com/snide/sphinx_rtd_theme/ +Version: 0.2.4 +Summary: Read the Docs theme for Sphinx +Home-page: https://github.com/rtfd/sphinx_rtd_theme/ Author: Dave Snider Author-email: dave.snider@gmail.com License: MIT @@ -25,12 +25,11 @@ View a working demo_ over on readthedocs.org_. - This is a mobile-friendly sphinx_ theme I made for readthedocs.org_. It's - currently in development there and includes some rtd variable checks that can be ignored - if you're just trying to use it on your project outside of that site. + This is a mobile-friendly sphinx_ theme I made for readthedocs.org_. - **This repo also exists as a submodule within the readthedocs itself**, so please make your edits to - the SASS files here, rather than the .css files on RTD. + If you'd like to update the theme, + please make your edits to the SASS files here, + rather than the .css files on checked into the repo. .. image:: screen_mobile.png :width: 100% @@ -57,6 +56,15 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + You may also specify a canonical url in conf.py to let search engines know + they should give higher ranking to latest version of the docs: + + .. code:: python + + html_theme_options['canonical_url'] = 'http://domain.tld/latest/docs/' + + The url points to the root of the documentation. It requires a trailing slash. + Via git or download ------------------- @@ -69,9 +77,87 @@ html_theme = "sphinx_rtd_theme" html_theme_path = ["_themes", ] + Configuration + ============= + + You can configure different parts of the theme. + + Project-wide configuration + -------------------------- + + 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 = { + 'collapse_navigation': False, + 'display_version': False, + 'navigation_depth': 3, + } + + Page-level configuration + ------------------------ + + Pages support metadata that changes how the theme renders. + You can currently add the following: + + * ``:github_url:`` This will force the "Edit on GitHub" to the configured URL + * ``: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 + Changelog ========= + master + ------ + + v0.2.4 + ------ + + * Yet another patch to deal with extra builders outside Spinx, such as the + singlehtml builders from the Read the Docs Sphinx extension + + v0.2.3 + ------ + + * Temporarily patch Sphinx issue with ``singlehtml`` builder by inspecting the + builder in template. + + v0.2.2 + ------ + + * Roll back toctree fix in 0.2.1 (#367). This didn't fix the issue and + introduced another bug with toctrees display. + + v0.2.1 + ------ + + * Add the ``rel`` HTML attribute to the footer links which point to + the previous and next pages. + * Fix toctree issue caused by Sphinx singlehtml builder (#367) + + v0.2.0 + ------ + + * Adds the ``comments`` block after the ``body`` block in the template + * Added "Edit on GitLab" support + * Many bug fixes + + v0.1.10-alpha + ------------- + + .. note:: + This is a pre-release version + + * Removes Sphinx dependency + * Fixes hamburger on mobile display + * Adds a ``body_begin`` block to the template + * Add ``prev_next_buttons_location`` which can take the value ``bottom``, + ``top``, ``both`` , ``None`` and will display the "Next" and "Previous" + buttons accordingly + v0.1.9 ------ @@ -215,13 +301,17 @@ * Separate some sass variables at the theme level so you can overwrite some basic colors. Platform: UNKNOWN -Classifier: Development Status :: 3 - Alpha -Classifier: License :: OSI Approved :: BSD License +Classifier: Development Status :: 5 - Production/Stable +Classifier: License :: OSI Approved :: MIT License Classifier: Environment :: Console Classifier: Environment :: Web Environment Classifier: Intended Audience :: Developers Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 +Classifier: Programming Language :: Python :: 3.3 +Classifier: Programming Language :: Python :: 3.4 +Classifier: Programming Language :: Python :: 3.5 +Classifier: Programming Language :: Python :: 3.6 Classifier: Operating System :: OS Independent Classifier: Topic :: Documentation Classifier: Topic :: Software Development :: Documentation diff -Nru sphinx-rtd-theme-0.1.9/README.rst sphinx-rtd-theme-0.2.4/README.rst --- sphinx-rtd-theme-0.1.9/README.rst 2015-09-15 21:20:40.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/README.rst 2017-03-06 23:34:07.000000000 +0000 @@ -17,12 +17,11 @@ View a working demo_ over on readthedocs.org_. -This is a mobile-friendly sphinx_ theme I made for readthedocs.org_. It's -currently in development there and includes some rtd variable checks that can be ignored -if you're just trying to use it on your project outside of that site. +This is a mobile-friendly sphinx_ theme I made for readthedocs.org_. -**This repo also exists as a submodule within the readthedocs itself**, so please make your edits to -the SASS files here, rather than the .css files on RTD. +If you'd like to update the theme, +please make your edits to the SASS files here, +rather than the .css files on checked into the repo. .. image:: screen_mobile.png :width: 100% @@ -49,6 +48,15 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +You may also specify a canonical url in conf.py to let search engines know +they should give higher ranking to latest version of the docs: + +.. code:: python + + html_theme_options['canonical_url'] = 'http://domain.tld/latest/docs/' + +The url points to the root of the documentation. It requires a trailing slash. + Via git or download ------------------- @@ -61,9 +69,87 @@ html_theme = "sphinx_rtd_theme" html_theme_path = ["_themes", ] +Configuration +============= + +You can configure different parts of the theme. + +Project-wide configuration +-------------------------- + +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 = { + 'collapse_navigation': False, + 'display_version': False, + 'navigation_depth': 3, + } + +Page-level configuration +------------------------ + +Pages support metadata that changes how the theme renders. +You can currently add the following: + +* ``:github_url:`` This will force the "Edit on GitHub" to the configured URL +* ``: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 + Changelog ========= +master +------ + +v0.2.4 +------ + +* Yet another patch to deal with extra builders outside Spinx, such as the + singlehtml builders from the Read the Docs Sphinx extension + +v0.2.3 +------ + +* Temporarily patch Sphinx issue with ``singlehtml`` builder by inspecting the + builder in template. + +v0.2.2 +------ + +* Roll back toctree fix in 0.2.1 (#367). This didn't fix the issue and + introduced another bug with toctrees display. + +v0.2.1 +------ + +* Add the ``rel`` HTML attribute to the footer links which point to + the previous and next pages. +* Fix toctree issue caused by Sphinx singlehtml builder (#367) + +v0.2.0 +------ + +* Adds the ``comments`` block after the ``body`` block in the template +* Added "Edit on GitLab" support +* Many bug fixes + +v0.1.10-alpha +------------- + +.. note:: + This is a pre-release version + +* Removes Sphinx dependency +* Fixes hamburger on mobile display +* Adds a ``body_begin`` block to the template +* Add ``prev_next_buttons_location`` which can take the value ``bottom``, + ``top``, ``both`` , ``None`` and will display the "Next" and "Previous" + buttons accordingly + v0.1.9 ------ diff -Nru sphinx-rtd-theme-0.1.9/requirements.txt sphinx-rtd-theme-0.2.4/requirements.txt --- sphinx-rtd-theme-0.1.9/requirements.txt 2015-07-16 19:05:46.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/requirements.txt 1970-01-01 00:00:00.000000000 +0000 @@ -1 +0,0 @@ -sphinx>=1.3 diff -Nru sphinx-rtd-theme-0.1.9/setup.cfg sphinx-rtd-theme-0.2.4/setup.cfg --- sphinx-rtd-theme-0.1.9/setup.cfg 2015-09-15 21:26:52.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/setup.cfg 2017-03-06 23:34:36.000000000 +0000 @@ -1,3 +1,6 @@ +[bdist_wheel] +universal = 1 + [egg_info] tag_build = tag_date = 0 diff -Nru sphinx-rtd-theme-0.1.9/setup.py sphinx-rtd-theme-0.2.4/setup.py --- sphinx-rtd-theme-0.1.9/setup.py 2015-09-09 03:02:58.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/setup.py 2017-03-06 23:34:07.000000000 +0000 @@ -11,11 +11,11 @@ setup( name='sphinx_rtd_theme', version=__version__, - url='https://github.com/snide/sphinx_rtd_theme/', + url='https://github.com/rtfd/sphinx_rtd_theme/', license='MIT', author='Dave Snider', author_email='dave.snider@gmail.com', - description='ReadTheDocs.org theme for Sphinx, 2013 version.', + description='Read the Docs theme for Sphinx', long_description=open('README.rst').read(), zip_safe=False, packages=['sphinx_rtd_theme'], @@ -27,15 +27,18 @@ 'static/font/*.*' ]}, include_package_data=True, - install_requires=open('requirements.txt').read().splitlines(), classifiers=[ - 'Development Status :: 3 - Alpha', - 'License :: OSI Approved :: BSD License', + 'Development Status :: 5 - Production/Stable', + 'License :: OSI Approved :: MIT License', 'Environment :: Console', 'Environment :: Web Environment', 'Intended Audience :: Developers', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', 'Operating System :: OS Independent', 'Topic :: Documentation', 'Topic :: Software Development :: Documentation', diff -Nru sphinx-rtd-theme-0.1.9/sphinx_rtd_theme/breadcrumbs.html sphinx-rtd-theme-0.2.4/sphinx_rtd_theme/breadcrumbs.html --- sphinx-rtd-theme-0.1.9/sphinx_rtd_theme/breadcrumbs.html 2015-09-15 20:36:52.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/sphinx_rtd_theme/breadcrumbs.html 2017-03-03 19:14:22.000000000 +0000 @@ -1,31 +1,82 @@ {# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} -{% if page_source_suffix %} +{% if page_source_suffix %} {% set suffix = page_source_suffix %} {% else %} {% set suffix = source_suffix %} {% endif %} +{% if meta is defined and meta is not none %} +{% set check_meta = True %} +{% else %} +{% set check_meta = False %} +{% endif %} + +{% if check_meta and 'github_url' in meta %} +{% set display_github = True %} +{% endif %} + +{% if check_meta and 'bitbucket_url' in meta %} +{% set display_bitbucket = True %} +{% endif %} + +{% if check_meta and 'gitlab_url' in meta %} +{% set display_gitlab = True %} +{% endif %} +
+ + + {% 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.1.9/sphinx_rtd_theme/footer.html sphinx-rtd-theme-0.2.4/sphinx_rtd_theme/footer.html --- sphinx-rtd-theme-0.1.9/sphinx_rtd_theme/footer.html 2015-09-15 20:36:52.000000000 +0000 +++ sphinx-rtd-theme-0.2.4/sphinx_rtd_theme/footer.html 2017-03-03 19:14:22.000000000 +0000 @@ -1,11 +1,11 @@