Hello community, here is the log from the commit of package python-sphinxcontrib-trio for openSUSE:Factory checked in at 2019-04-26 22:43:20 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/python-sphinxcontrib-trio (Old) and /work/SRC/openSUSE:Factory/.python-sphinxcontrib-trio.new.5536 (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Package is "python-sphinxcontrib-trio" Fri Apr 26 22:43:20 2019 rev:4 rq:697383 version:1.0.2 Changes: -------- --- /work/SRC/openSUSE:Factory/python-sphinxcontrib-trio/python-sphinxcontrib-trio.changes 2019-02-26 22:15:52.630201602 +0100 +++ /work/SRC/openSUSE:Factory/.python-sphinxcontrib-trio.new.5536/python-sphinxcontrib-trio.changes 2019-04-26 22:43:21.433677051 +0200 @@ -1,0 +2,13 @@ +Tue Apr 23 12:38:51 UTC 2019 - Jan Engelhardt + +- Use noun phrase in summary. + +------------------------------------------------------------------- +Tue Apr 23 11:45:34 UTC 2019 - Marketa Calabkova + +- update to version 1.0.2 + * Previously, on Sphinx 1.7, autodoc_member_order="bysource" + didn't work correctly for async methods. Now, it does. + * Remove support for sphinx<1.6. + +------------------------------------------------------------------- Old: ---- sphinxcontrib-trio-1.0.1.tar.gz New: ---- sphinxcontrib-trio-1.0.2.tar.gz ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ python-sphinxcontrib-trio.spec ++++++ --- /var/tmp/diff_new_pack.hYBKZ3/_old 2019-04-26 22:43:22.037676742 +0200 +++ /var/tmp/diff_new_pack.hYBKZ3/_new 2019-04-26 22:43:22.037676742 +0200 @@ -19,18 +19,24 @@ %define skip_python2 1 %{?!python_module:%define python_module() python-%{**} python3-%{**}} Name: python-sphinxcontrib-trio -Version: 1.0.1 +Version: 1.0.2 Release: 0 -Summary: Make Sphinx better at documenting Python functions and methods +Summary: Sphinx extension for documenting Python functions and methods License: MIT OR Apache-2.0 Group: Development/Languages/Python URL: https://github.com/python-trio/sphinxcontrib-trio Source: https://files.pythonhosted.org/packages/source/s/sphinxcontrib-trio/sphinxcontrib-trio-%{version}.tar.gz -# https://github.com/python-trio/sphinxcontrib-trio/issues/18 +BuildRequires: %{python_module Sphinx >= 1.6} +BuildRequires: %{python_module async_generator} +BuildRequires: %{python_module cssselect} +BuildRequires: %{python_module lxml} +BuildRequires: %{python_module pytest-cov} +BuildRequires: %{python_module pytest} BuildRequires: %{python_module setuptools} +BuildRequires: %{python_module urllib3 >= 1.21.1} BuildRequires: fdupes BuildRequires: python-rpm-macros -Requires: python-Sphinx +Requires: python-Sphinx >= 1.6 BuildArch: noarch %python_subpackages @@ -51,6 +57,9 @@ %python_install %python_expand %fdupes %{buildroot}%{$python_sitelib} +%check +%pytest tests + %files %{python_files} %doc README.rst %license LICENSE LICENSE.MIT LICENSE.APACHE2 ++++++ sphinxcontrib-trio-1.0.1.tar.gz -> sphinxcontrib-trio-1.0.2.tar.gz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/sphinxcontrib-trio-1.0.1/PKG-INFO new/sphinxcontrib-trio-1.0.2/PKG-INFO --- old/sphinxcontrib-trio-1.0.1/PKG-INFO 2018-02-06 09:36:41.000000000 +0100 +++ new/sphinxcontrib-trio-1.0.2/PKG-INFO 2019-01-28 04:45:56.000000000 +0100 @@ -1,12 +1,11 @@ Metadata-Version: 1.1 Name: sphinxcontrib-trio -Version: 1.0.1 +Version: 1.0.2 Summary: Make Sphinx better at documenting Python functions and methods Home-page: https://github.com/python-trio/sphinxcontrib-trio Author: Nathaniel J. Smith Author-email: njs@pobox.com License: MIT -or- Apache License 2.0 -Description-Content-Type: UNKNOWN Description: .. note that this README gets 'include'ed into the main documentation sphinxcontrib-trio @@ -59,5 +58,8 @@ Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Framework :: Sphinx :: Extension +Classifier: Framework :: Trio +Classifier: Framework :: AsyncIO +Classifier: Framework :: Twisted Classifier: Topic :: Documentation :: Sphinx Classifier: Topic :: Software Development :: Documentation diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/sphinxcontrib-trio-1.0.1/docs/source/index.rst new/sphinxcontrib-trio-1.0.2/docs/source/index.rst --- old/sphinxcontrib-trio-1.0.1/docs/source/index.rst 2018-02-06 09:32:04.000000000 +0100 +++ new/sphinxcontrib-trio-1.0.2/docs/source/index.rst 2019-01-28 04:27:50.000000000 +0100 @@ -294,6 +294,22 @@ .. towncrier release notes start +Sphinxcontrib_Trio 1.0.2 (2019-01-27) ++++++++++++++++++++++++++++++++++++++ + +Bugfixes +~~~~~~~~ + +- Previously, on Sphinx 1.7, ``autodoc_member_order="bysource"`` didn't work correctly + for async methods. Now, it does. (`#13 https://github.com/python-trio/sphinxcontrib-trio/issues/13`__) + + +Deprecations and Removals +~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Remove support for sphinx<1.6. (`#14 https://github.com/python-trio/sphinxcontrib-trio/issues/14`__) + + sphinxcontrib-trio 1.0.1 (2018-02-06) +++++++++++++++++++++++++++++++++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/sphinxcontrib-trio-1.0.1/setup.py new/sphinxcontrib-trio-1.0.2/setup.py --- old/sphinxcontrib-trio-1.0.1/setup.py 2017-05-12 09:24:33.000000000 +0200 +++ new/sphinxcontrib-trio-1.0.2/setup.py 2018-08-06 04:17:13.000000000 +0200 @@ -27,6 +27,9 @@ "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Framework :: Sphinx :: Extension", + "Framework :: Trio", + "Framework :: AsyncIO", + "Framework :: Twisted", "Topic :: Documentation :: Sphinx", "Topic :: Software Development :: Documentation", ]) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/sphinxcontrib-trio-1.0.1/sphinxcontrib_trio/__init__.py new/sphinxcontrib-trio-1.0.2/sphinxcontrib_trio/__init__.py --- old/sphinxcontrib-trio-1.0.1/sphinxcontrib_trio/__init__.py 2018-02-06 09:28:44.000000000 +0100 +++ new/sphinxcontrib-trio-1.0.2/sphinxcontrib_trio/__init__.py 2019-01-28 04:24:35.000000000 +0100 @@ -376,4 +376,15 @@ del directives._directives["automethod"] app.add_autodocumenter(ExtendedFunctionDocumenter) app.add_autodocumenter(ExtendedMethodDocumenter) + + # A monkey-patch to VariableCommentPicker to make autodoc_member_order = 'bysource' work. + try: + from sphinx.pycode.parser import VariableCommentPicker + except ImportError: + # Sphinx <1.7, it works out of the box. + pass + else: + if not hasattr(VariableCommentPicker, "visit_AsyncFunctionDef"): # pragma: no branch + VariableCommentPicker.visit_AsyncFunctionDef = VariableCommentPicker.visit_FunctionDef + return {'version': __version__, 'parallel_read_safe': True} diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/sphinxcontrib-trio-1.0.1/sphinxcontrib_trio/_version.py new/sphinxcontrib-trio-1.0.2/sphinxcontrib_trio/_version.py --- old/sphinxcontrib-trio-1.0.1/sphinxcontrib_trio/_version.py 2018-02-06 09:31:14.000000000 +0100 +++ new/sphinxcontrib-trio-1.0.2/sphinxcontrib_trio/_version.py 2019-01-28 04:27:01.000000000 +0100 @@ -1 +1 @@ -__version__ = "1.0.1" +__version__ = "1.0.2" diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/sphinxcontrib-trio-1.0.1/sphinxcontrib_trio.egg-info/PKG-INFO new/sphinxcontrib-trio-1.0.2/sphinxcontrib_trio.egg-info/PKG-INFO --- old/sphinxcontrib-trio-1.0.1/sphinxcontrib_trio.egg-info/PKG-INFO 2018-02-06 09:36:41.000000000 +0100 +++ new/sphinxcontrib-trio-1.0.2/sphinxcontrib_trio.egg-info/PKG-INFO 2019-01-28 04:45:56.000000000 +0100 @@ -1,12 +1,11 @@ Metadata-Version: 1.1 Name: sphinxcontrib-trio -Version: 1.0.1 +Version: 1.0.2 Summary: Make Sphinx better at documenting Python functions and methods Home-page: https://github.com/python-trio/sphinxcontrib-trio Author: Nathaniel J. Smith Author-email: njs@pobox.com License: MIT -or- Apache License 2.0 -Description-Content-Type: UNKNOWN Description: .. note that this README gets 'include'ed into the main documentation sphinxcontrib-trio @@ -59,5 +58,8 @@ Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Framework :: Sphinx :: Extension +Classifier: Framework :: Trio +Classifier: Framework :: AsyncIO +Classifier: Framework :: Twisted Classifier: Topic :: Documentation :: Sphinx Classifier: Topic :: Software Development :: Documentation diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/sphinxcontrib-trio-1.0.1/tests/test-docs-source/autodoc_examples.py new/sphinxcontrib-trio-1.0.2/tests/test-docs-source/autodoc_examples.py --- old/sphinxcontrib-trio-1.0.1/tests/test-docs-source/autodoc_examples.py 2018-02-06 09:28:44.000000000 +0100 +++ new/sphinxcontrib-trio-1.0.2/tests/test-docs-source/autodoc_examples.py 2018-08-06 02:42:40.000000000 +0200 @@ -31,5 +31,19 @@ pass +class ExampleClassForOrder: + async def d_asyncmethod(self): + pass + + def a_syncmethod(self): + pass + + async def c_asyncmethod(self): + pass + + def b_syncmethod(self): + pass + + async def autosummary_me(): pass diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/sphinxcontrib-trio-1.0.1/tests/test-docs-source/test.rst new/sphinxcontrib-trio-1.0.2/tests/test-docs-source/test.rst --- old/sphinxcontrib-trio-1.0.1/tests/test-docs-source/test.rst 2018-02-06 09:28:44.000000000 +0100 +++ new/sphinxcontrib-trio-1.0.2/tests/test-docs-source/test.rst 2018-08-06 02:42:40.000000000 +0200 @@ -260,6 +260,13 @@ <em class="property">await </em><code class="descname">asyncmethod</code> +Autodoc + order by source: + +.. autoclass:: ExampleClassForOrder + :members: + :undoc-members: + + Autodoc + explicit options: .. note:: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/sphinxcontrib-trio-1.0.1/tests/test_sphinxcontrib_trio.py new/sphinxcontrib-trio-1.0.2/tests/test_sphinxcontrib_trio.py --- old/sphinxcontrib-trio-1.0.1/tests/test_sphinxcontrib_trio.py 2018-02-06 09:28:44.000000000 +0100 +++ new/sphinxcontrib-trio-1.0.2/tests/test_sphinxcontrib_trio.py 2018-08-06 02:42:40.000000000 +0200 @@ -216,3 +216,22 @@ for note in tree.cssselect(".note"): do_html_test(note) + + +def test_member_order(tmpdir): + shutil.copytree(str(Path(__file__).parent / "test-docs-source"), + str(tmpdir / "test-docs-source")) + + subprocess.run( + ["sphinx-build", "-v", "-nW", "-D", "autodoc_member_order=bysource", "-nb", "html", + str(tmpdir / "test-docs-source"), str(tmpdir / "out")]) + + tree = lxml.html.parse(str(tmpdir / "out" / "test.html")).getroot() + + print("\n-- test case member order by source. --\n") + + methods = tree.cssselect(r"#autodoc_examples\.ExampleClassForOrder")[0].getnext().cssselect("dt") + + names = [method.get("id").split(".")[-1] for method in methods] + + assert names == ["d_asyncmethod", "a_syncmethod", "c_asyncmethod", "b_syncmethod"]