Script 'mail_helper' called by obssrc Hello community, here is the log from the commit of package python-readthedocs-sphinx-ext for openSUSE:Factory checked in at 2022-03-31 17:18:07 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/python-readthedocs-sphinx-ext (Old) and /work/SRC/openSUSE:Factory/.python-readthedocs-sphinx-ext.new.1900 (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-readthedocs-sphinx-ext" Thu Mar 31 17:18:07 2022 rev:9 rq:965272 version:2.1.5 Changes: -------- --- /work/SRC/openSUSE:Factory/python-readthedocs-sphinx-ext/python-readthedocs-sphinx-ext.changes 2022-02-03 23:16:38.464549453 +0100 +++ /work/SRC/openSUSE:Factory/.python-readthedocs-sphinx-ext.new.1900/python-readthedocs-sphinx-ext.changes 2022-03-31 17:18:08.257645032 +0200 @@ -1,0 +2,6 @@ +Fri Mar 18 22:29:34 UTC 2022 - Arun Persaud <a...@gmx.de> + +- update to version 2.1.5: + * Search: correctly remove Search.init on Sphinx >= 5.0 + +------------------------------------------------------------------- Old: ---- readthedocs-sphinx-ext-2.1.4.tar.gz New: ---- readthedocs-sphinx-ext-2.1.5.tar.gz ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ python-readthedocs-sphinx-ext.spec ++++++ --- /var/tmp/diff_new_pack.EIlyve/_old 2022-03-31 17:18:09.545630503 +0200 +++ /var/tmp/diff_new_pack.EIlyve/_new 2022-03-31 17:18:09.549630458 +0200 @@ -18,7 +18,7 @@ %{?!python_module:%define python_module() python-%{**} python3-%{**}} Name: python-readthedocs-sphinx-ext -Version: 2.1.4 +Version: 2.1.5 Release: 0 Summary: Sphinx extension for Read the Docs overrides License: MIT ++++++ readthedocs-sphinx-ext-2.1.4.tar.gz -> readthedocs-sphinx-ext-2.1.5.tar.gz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.4/PKG-INFO new/readthedocs-sphinx-ext-2.1.5/PKG-INFO --- old/readthedocs-sphinx-ext-2.1.4/PKG-INFO 2021-03-17 19:55:27.000000000 +0100 +++ new/readthedocs-sphinx-ext-2.1.5/PKG-INFO 2022-03-15 22:57:16.469287400 +0100 @@ -1,43 +1,46 @@ -Metadata-Version: 1.0 +Metadata-Version: 2.1 Name: readthedocs-sphinx-ext -Version: 2.1.4 +Version: 2.1.5 Summary: Sphinx extension for Read the Docs overrides Home-page: http://github.com/readthedocs/readthedocs-sphinx-ext Author: Read the Docs, Inc Author-email: d...@readthedocs.com License: MIT -Description: Read the Docs Sphinx Extensions - =============================== - - .. image:: https://img.shields.io/pypi/v/readthedocs-sphinx-ext.svg - :target: https://pypi.python.org/pypi/readthedocs-sphinx-ext - :alt: Pypi Version - .. image:: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext.svg?branch=master - :target: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext - :alt: Build Status - - This module adds extensions that make Sphinx easier to use. - Some of them require Read the Docs features, - others are just code that we ship and enable during builds on Read the Docs. - - We currently ship: - - * An extension for building docs like Read the Docs - * ``template-meta`` - Allows users to specify template overrides in per-page context. - - - Releasing - --------- - - #. Increment the version in ``setup.py`` - #. Tag the release in git: ``git tag $NEW_VERSION``. - #. Push the tag to GitHub: ``git push --tags origin master`` - #. Upload the package to PyPI: - - .. code:: bash - - $ rm -rf dist/ - $ python setup.py sdist bdist_wheel - $ twine upload --sign --identity secur...@readthedocs.org dist/* - Platform: UNKNOWN +License-File: LICENSE + +Read the Docs Sphinx Extensions +=============================== + +.. image:: https://img.shields.io/pypi/v/readthedocs-sphinx-ext.svg + :target: https://pypi.python.org/pypi/readthedocs-sphinx-ext + :alt: Pypi Version +.. image:: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext.svg?branch=master + :target: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext + :alt: Build Status + +This module adds extensions that make Sphinx easier to use. +Some of them require Read the Docs features, +others are just code that we ship and enable during builds on Read the Docs. + +We currently ship: + +* An extension for building docs like Read the Docs +* ``template-meta`` - Allows users to specify template overrides in per-page context. + + +Releasing +--------- + +#. Increment the version in ``setup.py`` +#. Tag the release in git: ``git tag $NEW_VERSION``. +#. Push the tag to GitHub: ``git push --tags origin master`` +#. Upload the package to PyPI: + + .. code:: bash + + $ rm -rf dist/ + $ python setup.py sdist bdist_wheel + $ twine upload --sign --identity secur...@readthedocs.org dist/* + + diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.4/readthedocs_ext/readthedocs.py new/readthedocs-sphinx-ext-2.1.5/readthedocs_ext/readthedocs.py --- old/readthedocs-sphinx-ext-2.1.4/readthedocs_ext/readthedocs.py 2021-03-17 19:33:39.000000000 +0100 +++ new/readthedocs-sphinx-ext-2.1.5/readthedocs_ext/readthedocs.py 2022-03-15 22:43:49.000000000 +0100 @@ -237,7 +237,15 @@ def remove_search_init(app, exception): - """Remove Sphinx's Search.init() so it can be initialized by Read the Docs.""" + """ + Remove Sphinx's Search.init() so it can be initialized by Read the Docs. + + RTD needs to call ``Search.init()`` after overriding some of its methods. + We remove the ``Search.init()`` call from Sphinx to avoid calling it twice. + + - https://github.com/sphinx-doc/sphinx/blob/799385f5558a888d1a143bf703d06b66d6717fe4/sphinx/themes/basic/static/searchtools.js#L527-L529 # noqa + - https://github.com/sphinx-doc/sphinx/blob/3b01fbe2adf3077cad5c2cf345c6d000d429d7ac/sphinx/themes/basic/static/searchtools.js#L507 # noqa + """ if exception: return @@ -249,9 +257,12 @@ replacement_text = '/* Search initialization removed for Read the Docs */' replacement_regex = re.compile( r''' - ^\$\(document\).ready\(function\s*\(\)\s*{(?:\n|\r\n?) + ^(\$\(document\).ready\(function\s*\(\)\s*{(?:\n|\r\n?) \s*Search.init\(\);(?:\n|\r\n?) - \}\); + \}\);) + | + # Sphinx >=5.0 calls Search.init this way. + (_ready\(Search.init\);) ''', (re.MULTILINE | re.VERBOSE) ) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.4/readthedocs_sphinx_ext.egg-info/PKG-INFO new/readthedocs-sphinx-ext-2.1.5/readthedocs_sphinx_ext.egg-info/PKG-INFO --- old/readthedocs-sphinx-ext-2.1.4/readthedocs_sphinx_ext.egg-info/PKG-INFO 2021-03-17 19:55:27.000000000 +0100 +++ new/readthedocs-sphinx-ext-2.1.5/readthedocs_sphinx_ext.egg-info/PKG-INFO 2022-03-15 22:57:16.000000000 +0100 @@ -1,43 +1,46 @@ -Metadata-Version: 1.0 +Metadata-Version: 2.1 Name: readthedocs-sphinx-ext -Version: 2.1.4 +Version: 2.1.5 Summary: Sphinx extension for Read the Docs overrides Home-page: http://github.com/readthedocs/readthedocs-sphinx-ext Author: Read the Docs, Inc Author-email: d...@readthedocs.com License: MIT -Description: Read the Docs Sphinx Extensions - =============================== - - .. image:: https://img.shields.io/pypi/v/readthedocs-sphinx-ext.svg - :target: https://pypi.python.org/pypi/readthedocs-sphinx-ext - :alt: Pypi Version - .. image:: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext.svg?branch=master - :target: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext - :alt: Build Status - - This module adds extensions that make Sphinx easier to use. - Some of them require Read the Docs features, - others are just code that we ship and enable during builds on Read the Docs. - - We currently ship: - - * An extension for building docs like Read the Docs - * ``template-meta`` - Allows users to specify template overrides in per-page context. - - - Releasing - --------- - - #. Increment the version in ``setup.py`` - #. Tag the release in git: ``git tag $NEW_VERSION``. - #. Push the tag to GitHub: ``git push --tags origin master`` - #. Upload the package to PyPI: - - .. code:: bash - - $ rm -rf dist/ - $ python setup.py sdist bdist_wheel - $ twine upload --sign --identity secur...@readthedocs.org dist/* - Platform: UNKNOWN +License-File: LICENSE + +Read the Docs Sphinx Extensions +=============================== + +.. image:: https://img.shields.io/pypi/v/readthedocs-sphinx-ext.svg + :target: https://pypi.python.org/pypi/readthedocs-sphinx-ext + :alt: Pypi Version +.. image:: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext.svg?branch=master + :target: https://travis-ci.org/readthedocs/readthedocs-sphinx-ext + :alt: Build Status + +This module adds extensions that make Sphinx easier to use. +Some of them require Read the Docs features, +others are just code that we ship and enable during builds on Read the Docs. + +We currently ship: + +* An extension for building docs like Read the Docs +* ``template-meta`` - Allows users to specify template overrides in per-page context. + + +Releasing +--------- + +#. Increment the version in ``setup.py`` +#. Tag the release in git: ``git tag $NEW_VERSION``. +#. Push the tag to GitHub: ``git push --tags origin master`` +#. Upload the package to PyPI: + + .. code:: bash + + $ rm -rf dist/ + $ python setup.py sdist bdist_wheel + $ twine upload --sign --identity secur...@readthedocs.org dist/* + + diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.4/readthedocs_sphinx_ext.egg-info/SOURCES.txt new/readthedocs-sphinx-ext-2.1.5/readthedocs_sphinx_ext.egg-info/SOURCES.txt --- old/readthedocs-sphinx-ext-2.1.4/readthedocs_sphinx_ext.egg-info/SOURCES.txt 2021-03-17 19:55:27.000000000 +0100 +++ new/readthedocs-sphinx-ext-2.1.5/readthedocs_sphinx_ext.egg-info/SOURCES.txt 2022-03-15 22:57:16.000000000 +0100 @@ -9,9 +9,6 @@ ./readthedocs_ext/readthedocs.py ./readthedocs_ext/template-meta.py ./readthedocs_ext/versionwarning.py -./tests/__init__.py -./tests/test_integration.py -./tests/util.py readthedocs_ext/_templates/readthedocs-insert.html.tmpl readthedocs_sphinx_ext.egg-info/PKG-INFO readthedocs_sphinx_ext.egg-info/SOURCES.txt diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.4/setup.py new/readthedocs-sphinx-ext-2.1.5/setup.py --- old/readthedocs-sphinx-ext-2.1.4/setup.py 2021-03-17 19:54:56.000000000 +0100 +++ new/readthedocs-sphinx-ext-2.1.5/setup.py 2022-03-15 22:48:54.000000000 +0100 @@ -4,7 +4,7 @@ setup( name='readthedocs-sphinx-ext', - version='2.1.4', + version='2.1.5', author='Read the Docs, Inc', author_email='d...@readthedocs.com', url='http://github.com/readthedocs/readthedocs-sphinx-ext', diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.4/tests/pr-example/conf.py new/readthedocs-sphinx-ext-2.1.5/tests/pr-example/conf.py --- old/readthedocs-sphinx-ext-2.1.4/tests/pr-example/conf.py 2021-03-17 19:33:39.000000000 +0100 +++ new/readthedocs-sphinx-ext-2.1.5/tests/pr-example/conf.py 2022-03-15 22:43:49.000000000 +0100 @@ -14,7 +14,7 @@ author = 'readthedocs' version = '0.1' release = '0.1' -language = None +language = 'en' exclude_patterns = ['_build'] todo_include_todos = False html_theme = 'alabaster' diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.4/tests/pyexample/conf.py new/readthedocs-sphinx-ext-2.1.5/tests/pyexample/conf.py --- old/readthedocs-sphinx-ext-2.1.4/tests/pyexample/conf.py 2021-03-17 19:33:39.000000000 +0100 +++ new/readthedocs-sphinx-ext-2.1.5/tests/pyexample/conf.py 2022-03-15 22:43:49.000000000 +0100 @@ -15,7 +15,7 @@ author = u'readthedocs' version = '0.1' release = '0.1' -language = None +language = 'en' exclude_patterns = ['_build'] pygments_style = 'sphinx' todo_include_todos = False diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.4/tests/pyexample-json/conf.py new/readthedocs-sphinx-ext-2.1.5/tests/pyexample-json/conf.py --- old/readthedocs-sphinx-ext-2.1.4/tests/pyexample-json/conf.py 2021-03-17 19:33:39.000000000 +0100 +++ new/readthedocs-sphinx-ext-2.1.5/tests/pyexample-json/conf.py 2022-03-15 22:43:49.000000000 +0100 @@ -15,7 +15,7 @@ author = u'readthedocs' version = '0.1' release = '0.1' -language = None +language = 'en' exclude_patterns = ['_build'] pygments_style = 'sphinx' todo_include_todos = False