forked from pool/python-sphinxcontrib-apidoc
- Add upstream patch sphinx-82.patch to support Sphinx >= 8.2
gh#sphinx-contrib/apidoc#23 OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-sphinxcontrib-apidoc?expand=0&rev=18
This commit is contained in:
Git OBS Bridge
23
.gitattributes
vendored
Normal file
23
.gitattributes
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
## Default LFS
|
||||
*.7z filter=lfs diff=lfs merge=lfs -text
|
||||
*.bsp filter=lfs diff=lfs merge=lfs -text
|
||||
*.bz2 filter=lfs diff=lfs merge=lfs -text
|
||||
*.gem filter=lfs diff=lfs merge=lfs -text
|
||||
*.gz filter=lfs diff=lfs merge=lfs -text
|
||||
*.jar filter=lfs diff=lfs merge=lfs -text
|
||||
*.lz filter=lfs diff=lfs merge=lfs -text
|
||||
*.lzma filter=lfs diff=lfs merge=lfs -text
|
||||
*.obscpio filter=lfs diff=lfs merge=lfs -text
|
||||
*.oxt filter=lfs diff=lfs merge=lfs -text
|
||||
*.pdf filter=lfs diff=lfs merge=lfs -text
|
||||
*.png filter=lfs diff=lfs merge=lfs -text
|
||||
*.rpm filter=lfs diff=lfs merge=lfs -text
|
||||
*.tbz filter=lfs diff=lfs merge=lfs -text
|
||||
*.tbz2 filter=lfs diff=lfs merge=lfs -text
|
||||
*.tgz filter=lfs diff=lfs merge=lfs -text
|
||||
*.ttf filter=lfs diff=lfs merge=lfs -text
|
||||
*.txz filter=lfs diff=lfs merge=lfs -text
|
||||
*.whl filter=lfs diff=lfs merge=lfs -text
|
||||
*.xz filter=lfs diff=lfs merge=lfs -text
|
||||
*.zip filter=lfs diff=lfs merge=lfs -text
|
||||
*.zst filter=lfs diff=lfs merge=lfs -text
|
||||
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
.osc
|
||||
3
_multibuild
Normal file
3
_multibuild
Normal file
@@ -0,0 +1,3 @@
|
||||
<multibuild>
|
||||
<package>test</package>
|
||||
</multibuild>
|
||||
76
python-sphinxcontrib-apidoc.changes
Normal file
76
python-sphinxcontrib-apidoc.changes
Normal file
@@ -0,0 +1,76 @@
|
||||
-------------------------------------------------------------------
|
||||
Thu Apr 24 12:42:27 UTC 2025 - Daniel Garcia <daniel.garcia@suse.com>
|
||||
|
||||
- Add upstream patch sphinx-82.patch to support Sphinx >= 8.2
|
||||
gh#sphinx-contrib/apidoc#23
|
||||
|
||||
-------------------------------------------------------------------
|
||||
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>
|
||||
|
||||
- add sphinx72.patch to fix tests, sent upstream
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Fri Apr 21 12:36:46 UTC 2023 - Dirk Müller <dmueller@suse.com>
|
||||
|
||||
- add sle15_python_module_pythons (jsc#PED-68)
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Thu Apr 13 22:45:05 UTC 2023 - Matej Cepl <mcepl@suse.com>
|
||||
|
||||
- Make calling of %{sle15modernpython} optional.
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Fri Apr 26 12:46:35 UTC 2019 - Marketa Calabkova <mcalabkova@suse.com>
|
||||
|
||||
- update to version 0.3.0
|
||||
* Ensure '--tocfile' isn't configured for Sphinx < 1.8
|
||||
* Support more configuration options
|
||||
* fix the dist name used to get the version after installation
|
||||
- Launching tests using multibuild. It just did not work without it.
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Fri Dec 7 20:49:39 UTC 2018 - Matej Cepl <mcepl@suse.com>
|
||||
|
||||
- Remove wrong BR on python-sphinxcontrib
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Tue Dec 4 12:54:37 UTC 2018 - Matej Cepl <mcepl@suse.com>
|
||||
|
||||
- Remove superfluous devel dependency for noarch package
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Mon Apr 16 08:51:13 UTC 2018 - tbechtold@suse.com
|
||||
|
||||
- Initial packaging (version 0.2.1)
|
||||
85
python-sphinxcontrib-apidoc.spec
Normal file
85
python-sphinxcontrib-apidoc.spec
Normal file
@@ -0,0 +1,85 @@
|
||||
#
|
||||
# spec file for package python-sphinxcontrib-apidoc
|
||||
#
|
||||
# Copyright (c) 2025 SUSE LLC
|
||||
#
|
||||
# All modifications and additions to the file contributed by third parties
|
||||
# remain the property of their copyright owners, unless otherwise agreed
|
||||
# upon. The license for this file, and modifications and additions to the
|
||||
# file, is the same license as for the pristine package itself (unless the
|
||||
# license for the pristine package is not an Open Source License, in which
|
||||
# case the license is the MIT License). An "Open Source License" is a
|
||||
# license that conforms to the Open Source Definition (Version 1.9)
|
||||
# published by the Open Source Initiative.
|
||||
|
||||
# Please submit bugfixes or comments via https://bugs.opensuse.org/
|
||||
#
|
||||
|
||||
|
||||
%{?!python_module:%define python_module() python-%{**} python3-%{**}}
|
||||
%global flavor @BUILD_FLAVOR@%{nil}
|
||||
%if "%{flavor}" == "test"
|
||||
%define psuffix -test
|
||||
%bcond_without test
|
||||
%else
|
||||
%define psuffix %{nil}
|
||||
%bcond_with test
|
||||
%endif
|
||||
%{?sle15_python_module_pythons}
|
||||
Name: python-sphinxcontrib-apidoc%{psuffix}
|
||||
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 sphinx-82.patch gh#sphinx-contrib/apidoc#23
|
||||
Patch0: sphinx-82.patch
|
||||
BuildRequires: %{python_module pbr >= 4.0}
|
||||
BuildRequires: %{python_module setuptools}
|
||||
BuildRequires: fdupes
|
||||
BuildRequires: python-rpm-macros
|
||||
Requires: python-Sphinx >= 5.0.0
|
||||
Requires: python-pbr
|
||||
BuildArch: noarch
|
||||
# SECTION test requirements
|
||||
%if %{with test}
|
||||
BuildRequires: %{python_module pytest >= 3.0}
|
||||
BuildRequires: %{python_module sphinxcontrib-apidoc = %{version}}
|
||||
%endif
|
||||
# /SECTION
|
||||
%python_subpackages
|
||||
|
||||
%description
|
||||
*sphinx-apidoc* is a tool for automatic generation of Sphinx sources that,
|
||||
using the `autodoc <sphinx_autodoc>`_ extension, documents a whole package in
|
||||
the style of other automatic API documentation tools. *sphinx-apidoc* does not
|
||||
actually build documentation - rather it simply generates it. As a result, it
|
||||
must be run before *sphinx-build*.
|
||||
|
||||
%prep
|
||||
%autosetup -p1 -n sphinxcontrib-apidoc-%{version}
|
||||
|
||||
%build
|
||||
%python_build
|
||||
|
||||
%install
|
||||
%if !%{with test}
|
||||
%python_install
|
||||
%python_expand %fdupes %{buildroot}%{$python_sitelib}
|
||||
%endif
|
||||
|
||||
%if %{with test}
|
||||
%check
|
||||
%pytest tests
|
||||
%endif
|
||||
|
||||
%if !%{with test}
|
||||
%files %{python_files}
|
||||
%license LICENSE
|
||||
%doc AUTHORS ChangeLog README.rst
|
||||
%{python_sitelib}/*
|
||||
%endif
|
||||
|
||||
%changelog
|
||||
23
sphinx-82.patch
Normal file
23
sphinx-82.patch
Normal file
@@ -0,0 +1,23 @@
|
||||
From d9440398976ad305697527fb5e27d8c3b5869fb7 Mon Sep 17 00:00:00 2001
|
||||
From: Karolina Surma <ksurma@redhat.com>
|
||||
Date: Thu, 3 Apr 2025 13:52:07 +0200
|
||||
Subject: [PATCH] Annotate the list of strings correctly for Sphinx 8.2+
|
||||
|
||||
This also works with an older Sphinx, tested on 8.1.3.
|
||||
---
|
||||
sphinxcontrib/apidoc/__init__.py | 2 +-
|
||||
1 file changed, 1 insertion(+), 1 deletion(-)
|
||||
|
||||
Index: sphinxcontrib-apidoc-0.5.0/sphinxcontrib/apidoc/__init__.py
|
||||
===================================================================
|
||||
--- sphinxcontrib-apidoc-0.5.0.orig/sphinxcontrib/apidoc/__init__.py
|
||||
+++ sphinxcontrib-apidoc-0.5.0/sphinxcontrib/apidoc/__init__.py
|
||||
@@ -24,7 +24,7 @@ def setup(app: Sphinx) -> Dict[str, Any]
|
||||
app.add_config_value('apidoc_module_dir', None, 'env', [str])
|
||||
app.add_config_value('apidoc_output_dir', 'api', 'env', [str])
|
||||
app.add_config_value('apidoc_template_dir', 'templates', 'env', [str])
|
||||
- app.add_config_value('apidoc_excluded_paths', [], 'env', [[str]])
|
||||
+ app.add_config_value('apidoc_excluded_paths', [], 'env', list[str])
|
||||
app.add_config_value('apidoc_separate_modules', False, 'env', [bool])
|
||||
app.add_config_value('apidoc_toc_file', None, 'env', [str, bool])
|
||||
app.add_config_value('apidoc_module_first', False, 'env', [bool])
|
||||
BIN
sphinxcontrib-apidoc-0.5.0.tar.gz
(Stored with Git LFS)
Normal file
BIN
sphinxcontrib-apidoc-0.5.0.tar.gz
(Stored with Git LFS)
Normal file
Binary file not shown.
Reference in New Issue
Block a user