Compare commits
31 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3fa5c435e1 | ||
|
|
386cb6e874 | ||
|
|
e4c31fd612 | ||
|
|
59303ae9d8 | ||
|
|
4ac821f497 | ||
|
|
b787bdf90d | ||
|
|
574c5a94d6 | ||
|
|
d241286834 | ||
|
|
78fa545ec7 | ||
|
|
0009cf4a25 | ||
|
|
31b58a6666 | ||
|
|
bd77693107 | ||
|
|
9db66313d0 | ||
|
|
9848821cbe | ||
|
|
8d9f71877e | ||
|
|
5e29644eb4 | ||
|
|
0522916ddc | ||
|
|
aa73a643c5 | ||
|
|
600e566ce8 | ||
|
|
94392caedd | ||
|
|
bdccc31518 | ||
|
|
1dedfd6334 | ||
|
|
de4dafa39e | ||
|
|
cca8be3e8b | ||
|
|
c97bb0f3e2 | ||
|
|
383e230ab0 | ||
|
|
f1121b8bac | ||
|
|
379ab359f3 | ||
|
|
fa05224c39 | ||
|
|
cc54017166 | ||
|
|
8f5d120071 |
1
.fmf/version
Normal file
1
.fmf/version
Normal file
@@ -0,0 +1 @@
|
||||
1
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -46,3 +46,7 @@
|
||||
/Sphinx-7.0.1.tar.gz
|
||||
/sphinx-7.1.2.tar.gz
|
||||
/sphinx-7.2.6.tar.gz
|
||||
/sphinx-7.3.7.tar.gz
|
||||
/sphinx-8.1.3.tar.gz
|
||||
/sphinx-8.2.3.tar.gz
|
||||
/sphinx-9.1.0.tar.gz
|
||||
|
||||
69
11774.patch
69
11774.patch
@@ -1,69 +0,0 @@
|
||||
From bc8939b34037f81b8610f3b26caec128ee20a2f4 Mon Sep 17 00:00:00 2001
|
||||
From: Karolina Surma <ksurma@redhat.com>
|
||||
Date: Tue, 28 Nov 2023 14:43:58 +0100
|
||||
Subject: [PATCH] Adjust the expected string to match Python 3.11+ changed
|
||||
output
|
||||
|
||||
---
|
||||
tests/test_ext_autodoc_configs.py | 21 +++++++++++++++++----
|
||||
1 file changed, 17 insertions(+), 4 deletions(-)
|
||||
|
||||
diff --git a/tests/test_ext_autodoc_configs.py b/tests/test_ext_autodoc_configs.py
|
||||
index 45bc729b73e..0994c08e899 100644
|
||||
--- a/tests/test_ext_autodoc_configs.py
|
||||
+++ b/tests/test_ext_autodoc_configs.py
|
||||
@@ -11,6 +11,7 @@
|
||||
from .test_ext_autodoc import do_autodoc
|
||||
|
||||
IS_PYPY = platform.python_implementation() == 'PyPy'
|
||||
+IS_PY311_AND_LATER = sys.version_info >= (3, 11)
|
||||
|
||||
|
||||
@contextmanager
|
||||
@@ -1627,7 +1628,10 @@ def test_autodoc_default_options(app):
|
||||
assert ' Iterate squares of each value.' in actual
|
||||
if not IS_PYPY:
|
||||
assert ' .. py:attribute:: CustomIter.__weakref__' in actual
|
||||
- assert ' list of weak references to the object (if defined)' in actual
|
||||
+ if IS_PY311_AND_LATER:
|
||||
+ assert ' list of weak references to the object' in actual
|
||||
+ else:
|
||||
+ assert ' list of weak references to the object (if defined)' in actual
|
||||
|
||||
# :exclude-members: None - has no effect. Unlike :members:,
|
||||
# :special-members:, etc. where None == "include all", here None means
|
||||
@@ -1651,7 +1655,10 @@ def test_autodoc_default_options(app):
|
||||
assert ' Iterate squares of each value.' in actual
|
||||
if not IS_PYPY:
|
||||
assert ' .. py:attribute:: CustomIter.__weakref__' in actual
|
||||
- assert ' list of weak references to the object (if defined)' in actual
|
||||
+ if IS_PY311_AND_LATER:
|
||||
+ assert ' list of weak references to the object' in actual
|
||||
+ else:
|
||||
+ assert ' list of weak references to the object (if defined)' in actual
|
||||
assert ' .. py:method:: CustomIter.snafucate()' in actual
|
||||
assert ' Makes this snafucated.' in actual
|
||||
|
||||
@@ -1698,7 +1705,10 @@ def test_autodoc_default_options_with_values(app):
|
||||
assert ' Iterate squares of each value.' in actual
|
||||
if not IS_PYPY:
|
||||
assert ' .. py:attribute:: CustomIter.__weakref__' not in actual
|
||||
- assert ' list of weak references to the object (if defined)' not in actual
|
||||
+ if IS_PY311_AND_LATER:
|
||||
+ assert ' list of weak references to the object' not in actual
|
||||
+ else:
|
||||
+ assert ' list of weak references to the object (if defined)' not in actual
|
||||
|
||||
# with :exclude-members:
|
||||
app.config.autodoc_default_options = {
|
||||
@@ -1722,6 +1732,9 @@ def test_autodoc_default_options_with_values(app):
|
||||
assert ' Iterate squares of each value.' in actual
|
||||
if not IS_PYPY:
|
||||
assert ' .. py:attribute:: CustomIter.__weakref__' not in actual
|
||||
- assert ' list of weak references to the object (if defined)' not in actual
|
||||
+ if IS_PY311_AND_LATER:
|
||||
+ assert ' list of weak references to the object' not in actual
|
||||
+ else:
|
||||
+ assert ' list of weak references to the object (if defined)' not in actual
|
||||
assert ' .. py:method:: CustomIter.snafucate()' not in actual
|
||||
assert ' Makes this snafucated.' not in actual
|
||||
@@ -1,58 +1,61 @@
|
||||
From 9699465414515f0eba76d05069e755b5bcf34eef Mon Sep 17 00:00:00 2001
|
||||
From 7b731f7ceb8161b11a529f182bf567b77993bdeb Mon Sep 17 00:00:00 2001
|
||||
From: Karolina Surma <ksurma@redhat.com>
|
||||
Date: Mon, 15 Jan 2024 16:19:32 +0100
|
||||
Date: Wed, 5 Mar 2025 12:14:49 +0100
|
||||
Subject: [PATCH] Make the first party extensions optional, add [extensions]
|
||||
extra
|
||||
|
||||
MIME-Version: 1.0
|
||||
Content-Type: text/plain; charset=UTF-8
|
||||
Content-Transfer-Encoding: 8bit
|
||||
|
||||
Co-authored-by: Miro Hrončok <miro@hroncok.cz>
|
||||
---
|
||||
pyproject.toml | 33 +++++++++++++++++++++++++++------
|
||||
sphinx/application.py | 6 +++---
|
||||
sphinx/registry.py | 9 ++++++---
|
||||
sphinx/testing/fixtures.py | 6 ++++++
|
||||
tests/test_api_translator.py | 2 ++
|
||||
tests/test_build_html.py | 3 +++
|
||||
6 files changed, 47 insertions(+), 12 deletions(-)
|
||||
pyproject.toml | 35 ++++++++++++++++----
|
||||
sphinx/application.py | 6 ++--
|
||||
sphinx/registry.py | 10 +++---
|
||||
sphinx/testing/fixtures.py | 7 ++++
|
||||
tests/test_builders/test_build_html_maths.py | 3 ++
|
||||
tests/test_writers/test_api_translator.py | 2 ++
|
||||
6 files changed, 50 insertions(+), 13 deletions(-)
|
||||
|
||||
diff --git a/pyproject.toml b/pyproject.toml
|
||||
index 8f93701..41c28c5 100644
|
||||
index 1195b04..9a7213f 100644
|
||||
--- a/pyproject.toml
|
||||
+++ b/pyproject.toml
|
||||
@@ -55,12 +55,6 @@ classifiers = [
|
||||
"Topic :: Utilities",
|
||||
@@ -67,12 +67,6 @@ classifiers = [
|
||||
"Typing :: Typed",
|
||||
]
|
||||
dependencies = [
|
||||
- "sphinxcontrib-applehelp",
|
||||
- "sphinxcontrib-devhelp",
|
||||
- "sphinxcontrib-jsmath",
|
||||
- "sphinxcontrib-htmlhelp>=2.0.0",
|
||||
- "sphinxcontrib-applehelp>=1.0.7",
|
||||
- "sphinxcontrib-devhelp>=1.0.6",
|
||||
- "sphinxcontrib-htmlhelp>=2.0.6",
|
||||
- "sphinxcontrib-jsmath>=1.0.1",
|
||||
- "sphinxcontrib-qthelp>=1.0.6",
|
||||
- "sphinxcontrib-serializinghtml>=1.1.9",
|
||||
- "sphinxcontrib-qthelp",
|
||||
"Jinja2>=3.0",
|
||||
"Pygments>=2.14",
|
||||
"docutils>=0.18.1,<0.21",
|
||||
@@ -76,8 +70,35 @@ dependencies = [
|
||||
"Jinja2>=3.1",
|
||||
"Pygments>=2.17",
|
||||
"docutils>=0.21,<0.23",
|
||||
@@ -87,6 +81,34 @@ dependencies = [
|
||||
]
|
||||
dynamic = ["version"]
|
||||
|
||||
[project.optional-dependencies]
|
||||
+[project.optional-dependencies]
|
||||
+applehelp = [
|
||||
+ "sphinxcontrib-applehelp",
|
||||
+ "sphinxcontrib-applehelp>=1.0.7",
|
||||
+]
|
||||
+devhelp = [
|
||||
+ "sphinxcontrib-devhelp",
|
||||
+ "sphinxcontrib-devhelp>=1.0.6",
|
||||
+]
|
||||
+jsmath = [
|
||||
+ "sphinxcontrib-jsmath",
|
||||
+ "sphinxcontrib-jsmath>=1.0.1",
|
||||
+]
|
||||
+htmlhelp = [
|
||||
+ "sphinxcontrib-htmlhelp>=2.0.0",
|
||||
+ "sphinxcontrib-htmlhelp>=2.0.6",
|
||||
+]
|
||||
+serializinghtml = [
|
||||
+ "sphinxcontrib-serializinghtml>=1.1.9",
|
||||
+]
|
||||
+qthelp = [
|
||||
+ "sphinxcontrib-qthelp",
|
||||
+ "sphinxcontrib-qthelp>=1.0.6",
|
||||
+]
|
||||
+extensions = [
|
||||
+ "sphinx[applehelp]",
|
||||
@@ -62,17 +65,23 @@ index 8f93701..41c28c5 100644
|
||||
+ "sphinx[serializinghtml]",
|
||||
+ "sphinx[qthelp]",
|
||||
+]
|
||||
+
|
||||
[[project.authors]]
|
||||
name = "Adam Turner"
|
||||
email = "aa-turner@users.noreply.github.com"
|
||||
@@ -104,6 +126,7 @@ sphinx-autogen = "sphinx.ext.autosummary.generate:main"
|
||||
[dependency-groups]
|
||||
docs = [
|
||||
"sphinxcontrib-websupport",
|
||||
+ "sphinx[extensions]",
|
||||
]
|
||||
lint = [
|
||||
"flake8>=3.5.0",
|
||||
"ruff==0.14.9",
|
||||
diff --git a/sphinx/application.py b/sphinx/application.py
|
||||
index d5fbaa9..b030dab 100644
|
||||
index 5349c36..4da1635 100644
|
||||
--- a/sphinx/application.py
|
||||
+++ b/sphinx/application.py
|
||||
@@ -226,7 +226,7 @@ class Sphinx:
|
||||
@@ -292,7 +292,7 @@ class Sphinx:
|
||||
# load all built-in extension modules, first-party extension modules,
|
||||
# and first-party themes
|
||||
for extension in builtin_extensions:
|
||||
@@ -81,7 +90,7 @@ index d5fbaa9..b030dab 100644
|
||||
|
||||
# load all user-given extension modules
|
||||
for extension in self.config.extensions:
|
||||
@@ -395,7 +395,7 @@ class Sphinx:
|
||||
@@ -494,7 +494,7 @@ class Sphinx:
|
||||
|
||||
# ---- general extensibility interface -------------------------------------
|
||||
|
||||
@@ -90,7 +99,7 @@ index d5fbaa9..b030dab 100644
|
||||
"""Import and setup a Sphinx extension module.
|
||||
|
||||
Load the extension given by the module *name*. Use this if your
|
||||
@@ -403,7 +403,7 @@ class Sphinx:
|
||||
@@ -502,7 +502,7 @@ class Sphinx:
|
||||
called twice.
|
||||
"""
|
||||
logger.debug('[app] setting up extension: %r', extname)
|
||||
@@ -100,19 +109,19 @@ index d5fbaa9..b030dab 100644
|
||||
@staticmethod
|
||||
def require_sphinx(version: tuple[int, int] | str) -> None:
|
||||
diff --git a/sphinx/registry.py b/sphinx/registry.py
|
||||
index 501661d..96d4554 100644
|
||||
index da72924..b6f6122 100644
|
||||
--- a/sphinx/registry.py
|
||||
+++ b/sphinx/registry.py
|
||||
@@ -430,7 +430,7 @@ class SphinxComponentRegistry:
|
||||
def add_html_theme(self, name: str, theme_path: str) -> None:
|
||||
self.html_themes[name] = theme_path
|
||||
@@ -528,7 +528,7 @@ class SphinxComponentRegistry:
|
||||
def add_html_theme(self, name: str, theme_path: str | os.PathLike[str]) -> None:
|
||||
self.html_themes[name] = _StrPath(theme_path)
|
||||
|
||||
- def load_extension(self, app: Sphinx, extname: str) -> None:
|
||||
+ def load_extension(self, app: Sphinx, extname: str, skip_nonimportable: bool = False) -> None:
|
||||
"""Load a Sphinx extension."""
|
||||
if extname in app.extensions: # already loaded
|
||||
return
|
||||
@@ -446,9 +446,12 @@ class SphinxComponentRegistry:
|
||||
@@ -549,10 +549,12 @@ class SphinxComponentRegistry:
|
||||
try:
|
||||
mod = import_module(extname)
|
||||
except ImportError as err:
|
||||
@@ -121,28 +130,30 @@ index 501661d..96d4554 100644
|
||||
+ logger.debug(msg % extname)
|
||||
+ return
|
||||
logger.verbose(__('Original exception:\n') + traceback.format_exc())
|
||||
- raise ExtensionError(__('Could not import extension %s') % extname,
|
||||
- err) from err
|
||||
- raise ExtensionError(
|
||||
- __('Could not import extension %s') % extname, err
|
||||
- ) from err
|
||||
+ raise ExtensionError(msg % extname, err) from err
|
||||
|
||||
setup = getattr(mod, 'setup', None)
|
||||
setup: _ExtensionSetupFunc | None = getattr(mod, 'setup', None)
|
||||
if setup is None:
|
||||
diff --git a/sphinx/testing/fixtures.py b/sphinx/testing/fixtures.py
|
||||
index 0cc4882..f57f709 100644
|
||||
index c6fdebe..e9f98a8 100644
|
||||
--- a/sphinx/testing/fixtures.py
|
||||
+++ b/sphinx/testing/fixtures.py
|
||||
@@ -22,6 +22,7 @@ DEFAULT_ENABLED_MARKERS = [
|
||||
'sphinx(builder, testroot=None, freshenv=False, confoverrides=None, tags=None,'
|
||||
' docutilsconf=None, parallel=0): arguments to initialize the sphinx test application.'
|
||||
@@ -31,6 +31,7 @@ DEFAULT_ENABLED_MARKERS = [
|
||||
'builddir=None, docutils_conf=None'
|
||||
'): arguments to initialize the sphinx test application.'
|
||||
),
|
||||
+ 'sphinxcontrib(...): required sphinxcontrib.* extensions',
|
||||
'test_params(shared_result=...): test parameters.',
|
||||
]
|
||||
|
||||
@@ -67,6 +68,11 @@ def app_params(request: Any, test_params: dict, shared_result: SharedResult,
|
||||
@@ -79,6 +80,12 @@ def app_params(
|
||||
"""Parameters that are specified by 'pytest.mark.sphinx' for
|
||||
sphinx.application.Sphinx initialization
|
||||
"""
|
||||
|
||||
+
|
||||
+ # ##### process pytest.mark.sphinxcontrib
|
||||
+ for info in reversed(list(request.node.iter_markers("sphinxcontrib"))):
|
||||
+ for arg in info.args:
|
||||
@@ -150,55 +161,55 @@ index 0cc4882..f57f709 100644
|
||||
+
|
||||
# ##### process pytest.mark.sphinx
|
||||
|
||||
pargs = {}
|
||||
diff --git a/tests/test_api_translator.py b/tests/test_api_translator.py
|
||||
index 9f2bd44..81575b7 100644
|
||||
--- a/tests/test_api_translator.py
|
||||
+++ b/tests/test_api_translator.py
|
||||
@@ -36,6 +36,7 @@ def test_singlehtml_set_translator_for_singlehtml(app, status, warning):
|
||||
pargs: dict[int, Any] = {}
|
||||
diff --git a/tests/test_builders/test_build_html_maths.py b/tests/test_builders/test_build_html_maths.py
|
||||
index 8654ca9..8ad006f 100644
|
||||
--- a/tests/test_builders/test_build_html_maths.py
|
||||
+++ b/tests/test_builders/test_build_html_maths.py
|
||||
@@ -40,6 +40,7 @@ def test_html_math_renderer_is_imgmath(app: SphinxTestApp) -> None:
|
||||
assert app.builder.math_renderer_name == 'imgmath'
|
||||
|
||||
|
||||
+@pytest.mark.sphinxcontrib('serializinghtml', 'jsmath')
|
||||
@pytest.mark.sphinx(
|
||||
'html',
|
||||
testroot='basic',
|
||||
@@ -67,6 +68,7 @@ def test_html_math_renderer_is_duplicated2(app: SphinxTestApp) -> None:
|
||||
assert app.builder.math_renderer_name == 'imgmath' # The another one is chosen
|
||||
|
||||
|
||||
+@pytest.mark.sphinxcontrib('jsmath')
|
||||
@pytest.mark.sphinx(
|
||||
'html',
|
||||
testroot='basic',
|
||||
@@ -80,6 +82,7 @@ def test_html_math_renderer_is_chosen(app: SphinxTestApp) -> None:
|
||||
assert app.builder.math_renderer_name == 'imgmath'
|
||||
|
||||
|
||||
+@pytest.mark.sphinxcontrib('jsmath')
|
||||
@pytest.mark.sphinx(
|
||||
'html',
|
||||
testroot='basic',
|
||||
diff --git a/tests/test_writers/test_api_translator.py b/tests/test_writers/test_api_translator.py
|
||||
index 1220192..8e8bb33 100644
|
||||
--- a/tests/test_writers/test_api_translator.py
|
||||
+++ b/tests/test_writers/test_api_translator.py
|
||||
@@ -47,6 +47,7 @@ def test_singlehtml_set_translator_for_singlehtml(app: SphinxTestApp) -> None:
|
||||
assert translator_class.__name__ == 'ConfSingleHTMLTranslator'
|
||||
|
||||
|
||||
+@pytest.mark.sphinxcontrib('serializinghtml')
|
||||
@pytest.mark.sphinx('pickle', testroot='api-set-translator')
|
||||
def test_pickle_set_translator_for_pickle(app, status, warning):
|
||||
def test_pickle_set_translator_for_pickle(app: SphinxTestApp) -> None:
|
||||
translator_class = app.builder.get_translator_class()
|
||||
@@ -43,6 +44,7 @@ def test_pickle_set_translator_for_pickle(app, status, warning):
|
||||
@@ -54,6 +55,7 @@ def test_pickle_set_translator_for_pickle(app: SphinxTestApp) -> None:
|
||||
assert translator_class.__name__ == 'ConfPickleTranslator'
|
||||
|
||||
|
||||
+@pytest.mark.sphinxcontrib('serializinghtml')
|
||||
@pytest.mark.sphinx('json', testroot='api-set-translator')
|
||||
def test_json_set_translator_for_json(app, status, warning):
|
||||
def test_json_set_translator_for_json(app: SphinxTestApp) -> None:
|
||||
translator_class = app.builder.get_translator_class()
|
||||
diff --git a/tests/test_build_html.py b/tests/test_build_html.py
|
||||
index 07f101d..c512a33 100644
|
||||
--- a/tests/test_build_html.py
|
||||
+++ b/tests/test_build_html.py
|
||||
@@ -1544,6 +1544,7 @@ def test_html_math_renderer_is_imgmath(app, status, warning):
|
||||
assert app.builder.math_renderer_name == 'imgmath'
|
||||
|
||||
|
||||
+@pytest.mark.sphinxcontrib('serializinghtml', 'jsmath')
|
||||
@pytest.mark.sphinx('html', testroot='basic',
|
||||
confoverrides={'extensions': ['sphinxcontrib.jsmath',
|
||||
'sphinx.ext.imgmath']})
|
||||
@@ -1564,6 +1565,7 @@ def test_html_math_renderer_is_duplicated2(app, status, warning):
|
||||
assert app.builder.math_renderer_name == 'imgmath' # The another one is chosen
|
||||
|
||||
|
||||
+@pytest.mark.sphinxcontrib('jsmath')
|
||||
@pytest.mark.sphinx('html', testroot='basic',
|
||||
confoverrides={'extensions': ['sphinxcontrib.jsmath',
|
||||
'sphinx.ext.imgmath'],
|
||||
@@ -1572,6 +1574,7 @@ def test_html_math_renderer_is_chosen(app, status, warning):
|
||||
assert app.builder.math_renderer_name == 'imgmath'
|
||||
|
||||
|
||||
+@pytest.mark.sphinxcontrib('jsmath')
|
||||
@pytest.mark.sphinx('html', testroot='basic',
|
||||
confoverrides={'extensions': ['sphinxcontrib.jsmath',
|
||||
'sphinx.ext.mathjax'],
|
||||
--
|
||||
2.43.0
|
||||
2.52.0
|
||||
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
# Without the packages, we have warnings in docs, but it's not a hard dependency
|
||||
# We don't want to support sphinxcontrib-* in RHEL, hence disabling the dependencies
|
||||
%bcond sphinxcontrib %{undefined rhel}
|
||||
# RHEL does not include python3-snowballstemmer (SRPM: snowball)
|
||||
%bcond snowballstemmer %{undefined rhel}
|
||||
# Also, we don't have all the tests requirements
|
||||
%bcond tests 1
|
||||
|
||||
@@ -14,14 +16,13 @@
|
||||
|
||||
# Build without BuildRequires ImageMagick, to skip imgconverter tests
|
||||
%bcond imagemagick_tests %{undefined rhel}
|
||||
# Same for filelock -- we don't want it in RHEL just to run a handful of tests here
|
||||
%bcond filelock_tests %{undefined rhel}
|
||||
|
||||
# During texlive updates, sometimes the latex environment is unstable
|
||||
# NOTE: LaTeX tests are never run when building for ELN.
|
||||
%bcond latex_tests 1
|
||||
|
||||
Name: python-sphinx
|
||||
%global general_version 7.2.6
|
||||
%global general_version 9.1.0
|
||||
#global prerel ...
|
||||
%global upstream_version %{general_version}%{?prerel}
|
||||
Version: %{general_version}%{?prerel:~%{prerel}}
|
||||
@@ -38,7 +39,7 @@ Source: %{pypi_source sphinx %{upstream_version}}
|
||||
|
||||
# Allow extra themes to exist. We pull in python3-sphinx-theme-alabaster
|
||||
# which causes that test to fail.
|
||||
Patch: sphinx-test_theming.diff
|
||||
Patch: sphinx-test_theming.patch
|
||||
|
||||
# Make the first party extensions optional
|
||||
# This removes the runtime dependencies on:
|
||||
@@ -56,10 +57,6 @@ Patch: sphinx-test_theming.diff
|
||||
# https://github.com/sphinx-doc/sphinx/pull/11747
|
||||
Patch: Make-the-first-party-extensions-optional.patch
|
||||
|
||||
# Fix the expected test docstring to match output in Python 3.11.7, 3.12.1 and later
|
||||
# Proposed upstream.
|
||||
Patch: https://github.com/sphinx-doc/sphinx/pull/11774.patch
|
||||
|
||||
BuildArch: noarch
|
||||
|
||||
BuildRequires: make
|
||||
@@ -88,36 +85,67 @@ BuildRequires: texinfo
|
||||
BuildRequires: ImageMagick
|
||||
%endif
|
||||
|
||||
%if %{with latex_tests}
|
||||
%if %{undefined rhel} && %{with latex_tests}
|
||||
BuildRequires: texlive-collection-fontsrecommended
|
||||
BuildRequires: texlive-collection-latex
|
||||
BuildRequires: texlive-gnu-freefont
|
||||
BuildRequires: latexmk
|
||||
BuildRequires: texlive-dvipng
|
||||
BuildRequires: texlive-dvisvgm
|
||||
BuildRequires: tex(article.cls)
|
||||
BuildRequires: tex(utf8x.def)
|
||||
# Other dependencies.
|
||||
BuildRequires: tex(alltt.sty)
|
||||
BuildRequires: tex(amsfonts.sty)
|
||||
BuildRequires: tex(amsmath.sty)
|
||||
BuildRequires: tex(amssymb.sty)
|
||||
BuildRequires: tex(amstext.sty)
|
||||
BuildRequires: tex(amsthm.sty)
|
||||
BuildRequires: tex(anyfontsize.sty)
|
||||
BuildRequires: tex(article.cls)
|
||||
BuildRequires: tex(atbegshi.sty)
|
||||
BuildRequires: tex(babel.sty)
|
||||
BuildRequires: tex(bm.sty)
|
||||
BuildRequires: tex(booktabs.sty)
|
||||
BuildRequires: tex(capt-of.sty)
|
||||
BuildRequires: tex(cmap.sty)
|
||||
BuildRequires: tex(color.sty)
|
||||
BuildRequires: tex(ctablestack.sty)
|
||||
BuildRequires: tex(colortbl.sty)
|
||||
BuildRequires: tex(ellipse.sty)
|
||||
BuildRequires: tex(etoolbox.sty)
|
||||
BuildRequires: tex(fancyhdr.sty)
|
||||
BuildRequires: tex(fancyvrb.sty)
|
||||
BuildRequires: tex(float.sty)
|
||||
BuildRequires: tex(fncychap.sty)
|
||||
BuildRequires: tex(fontawesome.sty)
|
||||
BuildRequires: tex(fontawesome5.sty)
|
||||
BuildRequires: tex(fontenc.sty)
|
||||
BuildRequires: tex(fontspec.sty)
|
||||
BuildRequires: tex(framed.sty)
|
||||
BuildRequires: tex(FreeSerif.otf)
|
||||
BuildRequires: tex(geometry.sty)
|
||||
BuildRequires: tex(graphicx.sty)
|
||||
BuildRequires: tex(hypcap.sty)
|
||||
BuildRequires: tex(hyperref.sty)
|
||||
BuildRequires: tex(inputenc.sty)
|
||||
BuildRequires: tex(kvoptions.sty)
|
||||
BuildRequires: tex(longtable.sty)
|
||||
BuildRequires: tex(ltxcmds.sty)
|
||||
BuildRequires: tex(luatex85.sty)
|
||||
BuildRequires: tex(makeidx.sty)
|
||||
BuildRequires: tex(multicol.sty)
|
||||
BuildRequires: tex(needspace.sty)
|
||||
BuildRequires: tex(parskip.sty)
|
||||
BuildRequires: tex(pict2e.sty)
|
||||
BuildRequires: tex(polyglossia.sty)
|
||||
BuildRequires: tex(remreset.sty)
|
||||
BuildRequires: tex(tabulary.sty)
|
||||
BuildRequires: tex(textalpha.sty)
|
||||
BuildRequires: tex(textcomp.sty)
|
||||
BuildRequires: tex(tgheros.sty)
|
||||
BuildRequires: tex(tgtermes.sty)
|
||||
BuildRequires: tex(titlesec.sty)
|
||||
BuildRequires: tex(upquote.sty)
|
||||
BuildRequires: tex(utf8x.def)
|
||||
BuildRequires: tex(varwidth.sty)
|
||||
BuildRequires: tex(wrapfig.sty)
|
||||
BuildRequires: tex(xcolor.sty)
|
||||
%endif
|
||||
%endif
|
||||
|
||||
@@ -156,6 +184,7 @@ Summary: Python documentation generator
|
||||
|
||||
Recommends: graphviz
|
||||
Recommends: ImageMagick
|
||||
Recommends: make
|
||||
|
||||
# Upstream Requires those, but we have a patch to remove the dependency.
|
||||
# We keep them Recommended to preserve the default user experience.
|
||||
@@ -196,39 +225,92 @@ the Python docs:
|
||||
snippets and inclusion of appropriately formatted docstrings.
|
||||
|
||||
|
||||
%if %{undefined rhel}
|
||||
%package -n python%{python3_pkgversion}-sphinx-latex
|
||||
Summary: LaTeX builder dependencies for python%{python3_pkgversion}-sphinx
|
||||
|
||||
Requires: python%{python3_pkgversion}-sphinx = %{epoch}:%{version}-%{release}
|
||||
# Required dependencies as stated in the documentation [1]:
|
||||
#
|
||||
# - texlive-collection-latexrecommended
|
||||
# - texlive-collection-fontsrecommended
|
||||
# - texlive-collection-fontsextra
|
||||
# - texlive-collection-latexextra
|
||||
# - texlive-tex-gyre
|
||||
# - latexmk
|
||||
#
|
||||
# [1] https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.latex.LaTeXBuilder
|
||||
#
|
||||
# These packages install 2500+ other packages requiring ~3 GiB of space.
|
||||
# Therefore, a more precise list of dependencies.
|
||||
|
||||
Requires: texlive-collection-fontsrecommended
|
||||
Requires: texlive-collection-latex
|
||||
Requires: texlive-gnu-freefont
|
||||
Requires: latexmk
|
||||
|
||||
# Required by sphinx.ext.imgmath – Render math as images
|
||||
Requires: texlive-dvipng
|
||||
Requires: texlive-dvisvgm
|
||||
#Requires: tex(preview.sty) Pulls in texlive-collection-latexrecommended
|
||||
|
||||
Requires: tex(article.cls)
|
||||
Requires: tex(utf8x.def)
|
||||
|
||||
# Other dependencies.
|
||||
# -- After searching for \RequirePackage{..} and \usepackage{..}.
|
||||
Requires: tex(alltt.sty)
|
||||
Requires: tex(amsfonts.sty)
|
||||
Requires: tex(amsmath.sty)
|
||||
Requires: tex(amssymb.sty)
|
||||
Requires: tex(amstext.sty)
|
||||
Requires: tex(amsthm.sty)
|
||||
Requires: tex(anyfontsize.sty)
|
||||
Requires: tex(article.cls)
|
||||
Requires: tex(atbegshi.sty)
|
||||
Requires: tex(babel.sty)
|
||||
Requires: tex(bm.sty)
|
||||
Requires: tex(booktabs.sty)
|
||||
Requires: tex(capt-of.sty)
|
||||
Requires: tex(cmap.sty)
|
||||
Requires: tex(color.sty)
|
||||
Requires: tex(ctablestack.sty)
|
||||
Requires: tex(colortbl.sty)
|
||||
Requires: tex(ellipse.sty)
|
||||
Requires: tex(etoolbox.sty)
|
||||
Requires: tex(fancyhdr.sty)
|
||||
Requires: tex(fancyvrb.sty)
|
||||
Requires: tex(float.sty)
|
||||
Requires: tex(fncychap.sty)
|
||||
Requires: tex(fontawesome.sty)
|
||||
Requires: tex(fontawesome5.sty)
|
||||
Requires: tex(fontenc.sty)
|
||||
Requires: tex(fontspec.sty)
|
||||
Requires: tex(framed.sty)
|
||||
Requires: tex(FreeSerif.otf)
|
||||
Requires: tex(geometry.sty)
|
||||
Requires: tex(graphicx.sty)
|
||||
Requires: tex(hypcap.sty)
|
||||
Requires: tex(hyperref.sty)
|
||||
Requires: tex(inputenc.sty)
|
||||
Requires: tex(kvoptions.sty)
|
||||
Requires: tex(longtable.sty)
|
||||
Requires: tex(ltxcmds.sty)
|
||||
Requires: tex(luatex85.sty)
|
||||
Requires: tex(makeidx.sty)
|
||||
Requires: tex(multicol.sty)
|
||||
Requires: tex(needspace.sty)
|
||||
Requires: tex(parskip.sty)
|
||||
Requires: tex(pict2e.sty)
|
||||
Requires: tex(polyglossia.sty)
|
||||
Requires: tex(remreset.sty)
|
||||
Requires: tex(tabulary.sty)
|
||||
Requires: tex(textalpha.sty)
|
||||
Requires: tex(textcomp.sty)
|
||||
Requires: tex(tgheros.sty)
|
||||
Requires: tex(tgtermes.sty)
|
||||
Requires: tex(titlesec.sty)
|
||||
Requires: tex(upquote.sty)
|
||||
Requires: tex(utf8x.def)
|
||||
Requires: tex(varwidth.sty)
|
||||
Requires: tex(wrapfig.sty)
|
||||
Requires: tex(xcolor.sty)
|
||||
#Requires: tex(xeCJK.sty) Pulls in pLaTeX and upLaTeX
|
||||
|
||||
# No files in this package, automatic provides don't work:
|
||||
%py_provides python%{python3_pkgversion}-sphinx-latex
|
||||
@@ -243,6 +325,7 @@ useful to many other projects.
|
||||
|
||||
This package pulls in the TeX dependencies needed by Sphinx's LaTeX
|
||||
builder.
|
||||
%endif
|
||||
|
||||
|
||||
%package doc
|
||||
@@ -264,30 +347,44 @@ This package contains documentation in the HTML format.
|
||||
%prep
|
||||
%autosetup -n sphinx-%{upstream_version} -p1
|
||||
|
||||
# Drop test-dependency on pytest-xdist
|
||||
# This allows for parallel testing, but has a lot of dependencies.
|
||||
# We want to avoid the dependency in RHEL, where it is not available.
|
||||
%if 0%{?rhel}
|
||||
sed -i -e '/pytest-xdist/d' pyproject.toml
|
||||
%endif
|
||||
|
||||
# sphinx 9.1.0 requires pytest >= 9, which we don't have in Fedora yet
|
||||
sed -i '/"pytest>=/ s/>=[^",]*//' pyproject.toml
|
||||
|
||||
# Drop test-dependency on defusedxml,
|
||||
# use xml from the standard library instead.
|
||||
# defusedxml is safer but this is only used in tests.
|
||||
# Upstream uses defusedxml to be "safer for future contributors when they
|
||||
# create/open branches and pull requests" -- that does not concern us.
|
||||
# https://github.com/sphinx-doc/sphinx/pull/12168#discussion_r1535383868
|
||||
# We want to avoid the dependency in RHEL, but no harm in doing so unconditionally.
|
||||
sed -i '/"defusedxml/d' pyproject.toml
|
||||
sed -i 's/from defusedxml./from xml.etree./' sphinx/testing/util.py tests/test_theming/test_theming.py
|
||||
|
||||
%if %{without snowballstemmer}
|
||||
# Drop dependency on snowballstemmer for RHEL, implement dummy method instead
|
||||
sed -i -e '/snowballstemmer/d' pyproject.toml
|
||||
sed -i -e 's/^import \(snowballstemmer\)/from . import dummystemmer as \1/' sphinx/search/*.py
|
||||
cat > sphinx/search/dummystemmer.py <<_EOF
|
||||
class stemmer:
|
||||
def __init__(self, *args, **kwargs): pass
|
||||
def stemWord(self, word): return word
|
||||
_EOF
|
||||
%endif
|
||||
|
||||
%if %{without imagemagick_tests}
|
||||
rm tests/test_ext_imgconverter.py
|
||||
rm -r tests/test_ext_imgconverter/
|
||||
%endif
|
||||
|
||||
%if %{without filelock_tests}
|
||||
sed -i '/filelock/d' pyproject.toml
|
||||
rm tests/test_build_linkcheck.py tests/test_ext_intersphinx.py
|
||||
%endif
|
||||
|
||||
%if %{defined rhel}
|
||||
# unwanted dependency in RHEL, https://bugzilla.redhat.com/show_bug.cgi?id=1945182
|
||||
sed -i '/html5lib/d' pyproject.toml
|
||||
%endif
|
||||
|
||||
# Sphinx' tests import from each other, this feature is not supported by
|
||||
# the 'importlib' import mode in pytest. Upstream mitigates this by invoking
|
||||
# `python -m pytest` rather than `pytest` directly, but in the context of the
|
||||
# RPM build we explicitly want to test the installed library rather than the
|
||||
# one from PWD.
|
||||
# https://github.com/sphinx-doc/sphinx/issues/11740
|
||||
sed -i '/"--import-mode=importlib",/d' pyproject.toml
|
||||
|
||||
%generate_buildrequires
|
||||
%pyproject_buildrequires -r %{?with_tests:-x test}
|
||||
%pyproject_buildrequires %{?with_tests:-g test}
|
||||
|
||||
|
||||
%build
|
||||
@@ -364,25 +461,28 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
|
||||
# Currently, all linkcheck tests and test_latex_images need internet
|
||||
# test_build_latex_doc needs internet to download pictures,
|
||||
# but fails also with it enabled, we decided to skip it entirely
|
||||
# In RHEL builds, skip tests which use html5lib (excluded above)
|
||||
%pytest \
|
||||
%if %{defined rhel}
|
||||
--ignore tests/test_build_html.py \
|
||||
--ignore tests/test_build_latex.py \
|
||||
--ignore tests/test_build_texinfo.py \
|
||||
--ignore tests/test_domain_std.py \
|
||||
--ignore tests/test_smartquotes.py \
|
||||
%endif
|
||||
# test_autodoc_type_aliases fails with Python 3.12.4, 3.13.0b3
|
||||
# skip temporarily until resolved:
|
||||
# https://github.com/sphinx-doc/sphinx/issues/12430
|
||||
k="not test_autodoc_type_aliases"
|
||||
%if %{without internet}
|
||||
-k "not linkcheck and not test_latex_images and not test_build_latex_doc" \
|
||||
%endif
|
||||
;
|
||||
k="${k} and not linkcheck and not test_latex_images and not test_build_latex_doc"
|
||||
%endif
|
||||
|
||||
%if %{without snowballstemmer}
|
||||
# Without snowballstemmer, some tests have to be skipped as well,
|
||||
# as the results with dummystemmer do not exactly match the testcases
|
||||
k="${k} and not test_meta_keys_are_handled_for_language_en and not test_stemmer"
|
||||
k="${k} and not test_term_in_heading_and_section and not test_IndexBuilder"
|
||||
k="${k} and not test_check_js_search_indexes"
|
||||
%endif
|
||||
|
||||
%pytest -k "${k}"
|
||||
%endif
|
||||
|
||||
%files -n python%{python3_pkgversion}-sphinx -f sphinx.lang
|
||||
%license LICENSE
|
||||
%doc AUTHORS CHANGES EXAMPLES README.rst
|
||||
%license LICENSE.rst
|
||||
%doc README.rst
|
||||
%{_bindir}/sphinx-*
|
||||
%{python3_sitelib}/sphinx/
|
||||
%dir %{python3_sitelib}/sphinxcontrib/
|
||||
@@ -392,13 +492,13 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
|
||||
%dir %{_datadir}/sphinx/locale/*
|
||||
%{_mandir}/man1/sphinx-*
|
||||
|
||||
|
||||
%if %{undefined rhel}
|
||||
%files -n python%{python3_pkgversion}-sphinx-latex
|
||||
# empty, this is a metapackage
|
||||
|
||||
%endif
|
||||
|
||||
%files doc
|
||||
%license LICENSE
|
||||
%license LICENSE.rst
|
||||
%doc html
|
||||
|
||||
|
||||
|
||||
2
sources
2
sources
@@ -1 +1 @@
|
||||
SHA512 (sphinx-7.2.6.tar.gz) = 9a42e38c3c54429cc008b58892297ade4ccdd67561ee671e42a1fae976955895bb5383d58cb66a4f9f7edd1cc50dc2d1f083efeef036eac9fffc205979d3ccbc
|
||||
SHA512 (sphinx-9.1.0.tar.gz) = 2c8b16935e14a8f827110461c530275f431949159eef47380198115d8abadaafdca06680c09722c0df7fd8ed8e16dbe1e3aa62a774164b7987247f6d8f8a20d3
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
diff -ru Sphinx-1.7.6/tests/test_theming.py Sphinx-1.7.6_patched/tests/test_theming.py
|
||||
--- Sphinx-1.7.6/tests/test_theming.py 2018-07-16 11:24:40.000000000 +0200
|
||||
+++ Sphinx-1.7.6_patched/tests/test_theming.py 2018-07-20 15:17:35.049263077 +0200
|
||||
@@ -25,7 +25,7 @@
|
||||
themes.append('alabaster')
|
||||
|
||||
# test Theme class API
|
||||
- assert set(app.registry.html_themes.keys()) == set(themes)
|
||||
+ assert set(app.registry.html_themes.keys()) >= set(themes)
|
||||
assert app.registry.html_themes['test-theme'] == str(app.srcdir / 'test_theme' / 'test-theme')
|
||||
assert app.registry.html_themes['ziptheme'] == str(app.srcdir / 'ziptheme.zip')
|
||||
assert app.registry.html_themes['staticfiles'] == str(app.srcdir / 'test_theme' / 'staticfiles')
|
||||
25
sphinx-test_theming.patch
Normal file
25
sphinx-test_theming.patch
Normal file
@@ -0,0 +1,25 @@
|
||||
From 399ae81dfbedb7b8acf84e56b0e4b2d5023432ec Mon Sep 17 00:00:00 2001
|
||||
From: Karolina Surma <ksurma@redhat.com>
|
||||
Date: Wed, 26 Feb 2025 10:43:44 +0100
|
||||
Subject: [PATCH] Patch test_theming to accomodate for Fedora-added theme
|
||||
|
||||
---
|
||||
tests/test_theming/test_theming.py | 2 +-
|
||||
1 file changed, 1 insertion(+), 1 deletion(-)
|
||||
|
||||
diff --git a/tests/test_theming/test_theming.py b/tests/test_theming/test_theming.py
|
||||
index 173e0c9..515e546 100644
|
||||
--- a/tests/test_theming/test_theming.py
|
||||
+++ b/tests/test_theming/test_theming.py
|
||||
@@ -58,7 +58,7 @@ def test_theme_api(app: SphinxTestApp) -> None:
|
||||
]
|
||||
|
||||
# test Theme class API
|
||||
- assert set(app.registry.html_themes.keys()) == set(themes)
|
||||
+ assert set(app.registry.html_themes.keys()) >= set(themes)
|
||||
assert app.registry.html_themes['test-theme'] == (
|
||||
app.srcdir / 'test_theme' / 'test-theme'
|
||||
)
|
||||
--
|
||||
2.48.1
|
||||
|
||||
11
tests/include-sphinxcontrib-jquery/main.fmf
Normal file
11
tests/include-sphinxcontrib-jquery/main.fmf
Normal file
@@ -0,0 +1,11 @@
|
||||
summary: run the basic documentation build
|
||||
test: |
|
||||
sphinx-build -M html source/ build/ &&
|
||||
grep '<script src="_static/jquery.js' build/html/index.html &&
|
||||
grep '<script src="_static/_sphinx_javascript_frameworks_compat.js' build/html/index.html &&
|
||||
test -f build/html/_static/jquery.js &&
|
||||
test -f build/html/_static/_sphinx_javascript_frameworks_compat.js &&
|
||||
rm -rf build/
|
||||
require:
|
||||
- python3-sphinx
|
||||
- python3-sphinxcontrib-jquery
|
||||
7
tests/include-sphinxcontrib-jquery/source/conf.py
Normal file
7
tests/include-sphinxcontrib-jquery/source/conf.py
Normal file
@@ -0,0 +1,7 @@
|
||||
project = 'Test'
|
||||
copyright = '2024, Test'
|
||||
author = 'Test'
|
||||
release = '0.3.0'
|
||||
extensions = [
|
||||
"sphinxcontrib.jquery",
|
||||
]
|
||||
15
tests/include-sphinxcontrib-jquery/source/index.rst
Normal file
15
tests/include-sphinxcontrib-jquery/source/index.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
Test docfile
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
10
tests/smoke-alabaster/main.fmf
Normal file
10
tests/smoke-alabaster/main.fmf
Normal file
@@ -0,0 +1,10 @@
|
||||
summary: run the basic documentation build
|
||||
test: |
|
||||
sphinx-build -M html source/ build/ &&
|
||||
grep '<section id="test-docfile">' build/html/index.html &&
|
||||
grep '<h1>Test docfile' build/html/index.html &&
|
||||
grep '_static/alabaster.css' build/html/index.html &&
|
||||
rm -rf build/
|
||||
require:
|
||||
- python3-sphinx
|
||||
- python3-sphinx-theme-alabaster
|
||||
5
tests/smoke-alabaster/source/conf.py
Normal file
5
tests/smoke-alabaster/source/conf.py
Normal file
@@ -0,0 +1,5 @@
|
||||
project = 'Test'
|
||||
copyright = '2024, Test'
|
||||
author = 'Test'
|
||||
release = '0.3.0'
|
||||
html_theme = 'alabaster'
|
||||
15
tests/smoke-alabaster/source/index.rst
Normal file
15
tests/smoke-alabaster/source/index.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
Test docfile
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
11
tests/smoke-rtd-theme/main.fmf
Normal file
11
tests/smoke-rtd-theme/main.fmf
Normal file
@@ -0,0 +1,11 @@
|
||||
summary: run the basic documentation build with sphinx-rtd-theme
|
||||
test: |
|
||||
sphinx-build -M html source/ build/ &&
|
||||
grep '<section id="test-docfile">' build/html/index.html &&
|
||||
grep '<h1>Test docfile' build/html/index.html &&
|
||||
grep 'SphinxRtdTheme' build/html/_static/js/theme.js &&
|
||||
grep '<script src="_static/js/theme.js' build/html/index.html &&
|
||||
rm -rf build/
|
||||
require:
|
||||
- python3-sphinx
|
||||
- python3-sphinx_rtd_theme
|
||||
8
tests/smoke-rtd-theme/source/conf.py
Normal file
8
tests/smoke-rtd-theme/source/conf.py
Normal file
@@ -0,0 +1,8 @@
|
||||
project = 'Test'
|
||||
copyright = '2024, Test'
|
||||
author = 'Test'
|
||||
release = '0.3.0'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
extensions = [
|
||||
'sphinx_rtd_theme',
|
||||
]
|
||||
15
tests/smoke-rtd-theme/source/index.rst
Normal file
15
tests/smoke-rtd-theme/source/index.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
Test docfile
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
Reference in New Issue
Block a user