Sync from SUSE:SLFO:Main python-sphinxcontrib-apidoc revision ea624750a0087cf7d5296fe890daf744

python-sphinxcontrib-apidoc.changes

@@ -1,3 +1,35 @@
+-------------------------------------------------------------------
+Sun Jan 21 10:54:27 UTC 2024 - Dirk Müller <dmueller@suse.com>
+
+- update to 0.5.0:
+  * Added quote marks to indicate default template dir is a
+    string
+  * Removed more white space to match required style
+  * Removed white space screwing with PR linter
+  * Added description of apidoc\_template\_dir option to README
+  * Added missed line in patch for templates support
+  * Added support for autodoc --templatedir option
+  * Use release/v1 branch of pypi release workflow
+
+-------------------------------------------------------------------
+Thu Oct  5 09:06:01 UTC 2023 - Dirk Müller <dmueller@suse.com>
+
+- update to 0.4.0:
+  * Remove docs build
+  * Fix lint issues
+  * Configure trusted publishing
+  * Migrate to Python 3-style type annotations
+  * Bump sphinx minimum
+  * Remove pytest upper cap
+  * Migrate to pre-commit
+  * Drop Python < 3.8 support
+  * Migrate from Travis to GitHub Actions
+  * tests: Handle Sphinx < 7.2
+  * fix tests with Sphinx 7.2
+  * README: Fix typo
+  * travis: Update PyPI password
+- drop sphinx72.patch (upstream)
+
 -------------------------------------------------------------------
 Wed Aug 30 11:27:32 UTC 2023 - Markéta Machová <mmachova@suse.com>
 

python-sphinxcontrib-apidoc.spec

@@ -1,7 +1,7 @@
 #
 # spec file
 #
-# Copyright (c) 2023 SUSE LLC
+# Copyright (c) 2024 SUSE LLC
 #
 # All modifications and additions to the file contributed by third parties
 # remain the property of their copyright owners, unless otherwise agreed
@@ -27,20 +27,18 @@
 %endif
 %{?sle15_python_module_pythons}
 Name:           python-sphinxcontrib-apidoc%{psuffix}
-Version:        0.3.0
+Version:        0.5.0
 Release:        0
 Summary:        A Sphinx extension for running 'sphinx-apidoc' on each build
 License:        BSD-2-Clause
 Group:          Development/Languages/Python
 URL:            http://www.sphinx-doc.org/
 Source:         https://files.pythonhosted.org/packages/source/s/sphinxcontrib-apidoc/sphinxcontrib-apidoc-%{version}.tar.gz
-#PATCH-FIX-UPSTREAM https://github.com/sphinx-contrib/apidoc/pull/18 fix tests with Sphinx 7.2
-Patch:          sphinx72.patch
 BuildRequires:  %{python_module pbr >= 4.0}
 BuildRequires:  %{python_module setuptools}
 BuildRequires:  fdupes
 BuildRequires:  python-rpm-macros
-Requires:       python-Sphinx >= 1.6.0
+Requires:       python-Sphinx >= 5.0.0
 Requires:       python-pbr
 BuildArch:      noarch
 # SECTION test requirements

sphinx72.patch

@@ -1,83 +0,0 @@
-Index: sphinxcontrib-apidoc-0.3.0/tests/conftest.py
-===================================================================
---- sphinxcontrib-apidoc-0.3.0.orig/tests/conftest.py
-+++ sphinxcontrib-apidoc-0.3.0/tests/conftest.py
-@@ -10,7 +10,7 @@ import os
- import tempfile
- 
- import pytest
--from sphinx.testing.path import path
-+from pathlib import Path
- 
- pytest_plugins = 'sphinx.testing.fixtures'
- 
-@@ -19,11 +19,10 @@ collect_ignore = ['roots']
- 
- @pytest.fixture(scope='session')
- def sphinx_test_tempdir():
--    return path(
-+    return Path(
-         os.environ.get('SPHINX_TEST_TEMPDIR',
--                       tempfile.mkdtemp(prefix='apidoc-'))).abspath()
--
-+                       tempfile.mkdtemp(prefix='apidoc-'))).resolve()
- 
- @pytest.fixture(scope='session')
- def rootdir():
--    return path(os.path.dirname(__file__) or '.').abspath() / 'roots'
-+    return Path(os.path.dirname(__file__) or '.').resolve() / 'roots'
-Index: sphinxcontrib-apidoc-0.3.0/tests/test_ext.py
-===================================================================
---- sphinxcontrib-apidoc-0.3.0.orig/tests/test_ext.py
-+++ sphinxcontrib-apidoc-0.3.0/tests/test_ext.py
-@@ -19,12 +19,12 @@ def test_basics(app, status, warning):
-     logging.setup(app, status, warning)
-     app.builder.build_all()
- 
--    assert (app.srcdir / 'api').isdir()
-+    assert (app.srcdir / 'api').is_dir()
-     assert (app.srcdir / 'api' / 'modules.rst').exists()
-     assert (app.srcdir / 'api' / 'apidoc_dummy_module.rst').exists()
-     assert not (app.srcdir / 'api' / 'conf.rst').exists()
- 
--    assert (app.outdir / 'api').isdir()
-+    assert (app.outdir / 'api').is_dir()
-     assert (app.outdir / 'api' / 'modules.html').exists()
-     assert (app.outdir / 'api' / 'apidoc_dummy_module.html').exists()
-     assert not (app.outdir / 'api' / 'conf.html').exists()
-@@ -40,7 +40,7 @@ def test_advanced(app, status, warning):
-     logging.setup(app, status, warning)
-     app.builder.build_all()
- 
--    assert (app.srcdir / 'api').isdir()
-+    assert (app.srcdir / 'api').is_dir()
-     assert (app.srcdir / 'api' / 'custom.rst').exists()
-     for module in [
-             'apidoc_dummy_module.rst',
-@@ -58,7 +58,7 @@ def test_advanced(app, status, warning):
-     # The 'Module contents' header isn't present if '--module-first' used
-     assert 'Module contents' not in package_doc
- 
--    assert (app.outdir / 'api').isdir()
-+    assert (app.outdir / 'api').is_dir()
-     assert (app.outdir / 'api' / 'custom.html').exists()
-     for module in [
-             'apidoc_dummy_module.html',
-@@ -79,7 +79,7 @@ def test_advanced_negative(app, status,
-     logging.setup(app, status, warning)
-     app.builder.build_all()
- 
--    assert (app.srcdir / 'api').isdir()
-+    assert (app.srcdir / 'api').is_dir()
-     for module in [
-             'apidoc_dummy_module.rst',
-     ]:
-@@ -94,7 +94,7 @@ def test_advanced_negative(app, status,
-     # The 'Module contents' header is present if '--module-first' isn't used
-     assert 'Module contents' in package_doc
- 
--    assert (app.outdir / 'api').isdir()
-+    assert (app.outdir / 'api').is_dir()
-     for module in [
-             'apidoc_dummy_module.html',
-     ]: