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-10-30 18:28:27
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python-readthedocs-sphinx-ext (Old)
and /work/SRC/openSUSE:Factory/.python-readthedocs-sphinx-ext.new.2275
(New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-readthedocs-sphinx-ext"
Sun Oct 30 18:28:27 2022 rev:12 rq:1032177 version:2.2.0
Changes:
--------
---
/work/SRC/openSUSE:Factory/python-readthedocs-sphinx-ext/python-readthedocs-sphinx-ext.changes
2022-10-14 15:40:28.379711375 +0200
+++
/work/SRC/openSUSE:Factory/.python-readthedocs-sphinx-ext.new.2275/python-readthedocs-sphinx-ext.changes
2022-10-30 18:28:31.514283643 +0100
@@ -1,0 +2,20 @@
+Sat Oct 29 00:11:21 UTC 2022 - Yogalakshmi Arunachalam <[email protected]>
+
+- Update to version 2.2.0
+ Telemetry: dump `app.extensions` and `app.config.html_theme` (#117)
+ * Telemetry: dump `app.extensions` and `app.config.html_theme`
+ Dump data from Sphinx into a JSON file that will be read and processed by
our
+ Telemetry collector. This will help us to get some insights about
extensions and
+ theme usage.
+ * Telemetry: handle unexpected exceptions
+ * Telemetry: comment about config-inited
+ * Style
+ * Telemetry: save only extensions defined by the user
+ Instead of saving `app.extensions` (all extensions used by Sphinx,
including
+ default ones), we only save `app.config.extensions` which are the ones
defined
+ by the user itself.
+ Update release steps (#116)
+ Use build is recommend now
+
https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#packaging-your-project
+
+-------------------------------------------------------------------
Old:
----
readthedocs-sphinx-ext-2.1.9.tar.gz
New:
----
readthedocs-sphinx-ext-2.2.0.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-readthedocs-sphinx-ext.spec ++++++
--- /var/tmp/diff_new_pack.mC1ykX/_old 2022-10-30 18:28:32.254287640 +0100
+++ /var/tmp/diff_new_pack.mC1ykX/_new 2022-10-30 18:28:32.258287663 +0100
@@ -18,7 +18,7 @@
%{?!python_module:%define python_module() python-%{**} python3-%{**}}
Name: python-readthedocs-sphinx-ext
-Version: 2.1.9
+Version: 2.2.0
Release: 0
Summary: Sphinx extension for Read the Docs overrides
License: MIT
++++++ readthedocs-sphinx-ext-2.1.9.tar.gz ->
readthedocs-sphinx-ext-2.2.0.tar.gz ++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.9/PKG-INFO
new/readthedocs-sphinx-ext-2.2.0/PKG-INFO
--- old/readthedocs-sphinx-ext-2.1.9/PKG-INFO 2022-09-15 00:34:22.603376900
+0200
+++ new/readthedocs-sphinx-ext-2.2.0/PKG-INFO 2022-10-25 17:59:36.479261900
+0200
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: readthedocs-sphinx-ext
-Version: 2.1.9
+Version: 2.2.0
Summary: Sphinx extension for Read the Docs overrides
Home-page: http://github.com/readthedocs/readthedocs-sphinx-ext
Author: Read the Docs, Inc
@@ -13,7 +13,7 @@
.. image:: https://img.shields.io/pypi/v/readthedocs-sphinx-ext.svg
:target: https://pypi.python.org/pypi/readthedocs-sphinx-ext
- :alt: Pypi Version
+ :alt: PyPI Version
.. image::
https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext.svg?style=svg
:target: https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext
:alt: Build Status
@@ -38,6 +38,7 @@
.. code:: bash
+ $ python -m pip install --upgrade pip build twine
$ rm -rf dist/
- $ python setup.py sdist bdist_wheel
+ $ python -m build --sdist --wheel
$ twine upload --sign --identity [email protected] dist/*
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.9/README.rst
new/readthedocs-sphinx-ext-2.2.0/README.rst
--- old/readthedocs-sphinx-ext-2.1.9/README.rst 2022-06-21 18:17:16.000000000
+0200
+++ new/readthedocs-sphinx-ext-2.2.0/README.rst 2022-10-25 17:53:21.000000000
+0200
@@ -3,7 +3,7 @@
.. image:: https://img.shields.io/pypi/v/readthedocs-sphinx-ext.svg
:target: https://pypi.python.org/pypi/readthedocs-sphinx-ext
- :alt: Pypi Version
+ :alt: PyPI Version
.. image::
https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext.svg?style=svg
:target: https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext
:alt: Build Status
@@ -28,6 +28,7 @@
.. code:: bash
+ $ python -m pip install --upgrade pip build twine
$ rm -rf dist/
- $ python setup.py sdist bdist_wheel
+ $ python -m build --sdist --wheel
$ twine upload --sign --identity [email protected] dist/*
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/readthedocs-sphinx-ext-2.1.9/readthedocs_ext/readthedocs.py
new/readthedocs-sphinx-ext-2.2.0/readthedocs_ext/readthedocs.py
--- old/readthedocs-sphinx-ext-2.1.9/readthedocs_ext/readthedocs.py
2022-06-21 18:17:16.000000000 +0200
+++ new/readthedocs-sphinx-ext-2.2.0/readthedocs_ext/readthedocs.py
2022-10-25 17:53:21.000000000 +0200
@@ -338,6 +338,29 @@
)
+def dump_telemetry(app, config):
+ # We need to get the output directory where the docs are built
+ # _build/json.
+ build_json = os.path.abspath(
+ os.path.join(app.outdir, '..', 'json')
+ )
+ outjson = os.path.join(build_json, 'telemetry.json')
+ outdir = os.path.dirname(outjson)
+
+ try:
+ if not os.path.exists(outdir):
+ os.makedirs(outdir)
+
+ with open(outjson, 'w+') as json_file:
+ data = {
+ 'extensions': app.config.extensions,
+ 'html_theme': app.config.html_theme,
+ }
+ json.dump(data, json_file, indent=4)
+ except Exception:
+ log.exception("Something went wrong when dumping Telemetry data.")
+
+
class ReadtheDocsBuilder(StandaloneHTMLBuilder):
"""
@@ -396,6 +419,10 @@
app.connect('build-finished', remove_search_init)
app.connect('build-finished', dump_sphinx_data)
+ if sphinx.version_info >= (1, 8, 0):
+ # `config-inited` event was introduced in Sphinx 1.8
+ app.connect('config-inited', dump_telemetry)
+
# Embed
app.add_directive('readthedocs-embed', EmbedDirective)
app.add_config_value('readthedocs_embed_project', '', 'html')
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/readthedocs-sphinx-ext-2.1.9/readthedocs_sphinx_ext.egg-info/PKG-INFO
new/readthedocs-sphinx-ext-2.2.0/readthedocs_sphinx_ext.egg-info/PKG-INFO
--- old/readthedocs-sphinx-ext-2.1.9/readthedocs_sphinx_ext.egg-info/PKG-INFO
2022-09-15 00:34:22.000000000 +0200
+++ new/readthedocs-sphinx-ext-2.2.0/readthedocs_sphinx_ext.egg-info/PKG-INFO
2022-10-25 17:59:36.000000000 +0200
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: readthedocs-sphinx-ext
-Version: 2.1.9
+Version: 2.2.0
Summary: Sphinx extension for Read the Docs overrides
Home-page: http://github.com/readthedocs/readthedocs-sphinx-ext
Author: Read the Docs, Inc
@@ -13,7 +13,7 @@
.. image:: https://img.shields.io/pypi/v/readthedocs-sphinx-ext.svg
:target: https://pypi.python.org/pypi/readthedocs-sphinx-ext
- :alt: Pypi Version
+ :alt: PyPI Version
.. image::
https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext.svg?style=svg
:target: https://circleci.com/gh/readthedocs/readthedocs-sphinx-ext
:alt: Build Status
@@ -38,6 +38,7 @@
.. code:: bash
+ $ python -m pip install --upgrade pip build twine
$ rm -rf dist/
- $ python setup.py sdist bdist_wheel
+ $ python -m build --sdist --wheel
$ twine upload --sign --identity [email protected] dist/*
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/readthedocs-sphinx-ext-2.1.9/setup.py
new/readthedocs-sphinx-ext-2.2.0/setup.py
--- old/readthedocs-sphinx-ext-2.1.9/setup.py 2022-09-15 00:13:08.000000000
+0200
+++ new/readthedocs-sphinx-ext-2.2.0/setup.py 2022-10-25 17:58:44.000000000
+0200
@@ -4,7 +4,7 @@
setup(
name='readthedocs-sphinx-ext',
- version='2.1.9',
+ version='2.2.0',
author='Read the Docs, Inc',
author_email='[email protected]',
url='http://github.com/readthedocs/readthedocs-sphinx-ext',
