python/python-Sphinx
SHA256
14
0
Fork 0
forked from pool/python-Sphinx
Code Pull Requests Activity

- update to 7.3.7:

Browse Source 
* #12299: Defer loading themes defined via entry points until
    their explicit use by the user or a child theme. Patch by
    Adam Turner.
  * #12305: Return the default value for theme.get_config() with
    an unsupported theme configuration section. Patch by Adam
    Turner.
  * #12295: Re-export all AST types in the C and C++ domains.
    Patch by Adam Turner.
  * #12295: Re-export various objects from
    sphinx.domains.python._annotations in sphinx.domains.python.
    Patch by Jacob Chesslo and Adam Turner.
  * #12295: Re-export various objects from
    sphinx.domains.python._object in sphinx.domains.python. Patch
    by Jacob Chesslo and Adam Turner.
  * Handle cases when Any is not an instance of type. Patch by
    Adam Turner.
  * #12290: Fix a false-positive warning when setting a
    configuration value with Any as the valid type to a type
    other than the value's default. Patch by Adam Turner.
  * Preload all themes defined via entry points. Patch by Adam
    Turner.
  * Fix a bad interaction between the 'Furo' theme and the new-
    style for configuration values. Patch by Adam Turner.
  * Require tomli on Python 3.10 and earlier. Patch by Adam
    Turner.
  * #11858: Increase the minimum supported version of Alabaster
    to 0.7.14. Patch by Adam Turner.
  * #11411: Support Docutils 0.21. Patch by Adam Turner.
  * #12012: Use types-docutils instead of docutils-stubs.

OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=264
This commit is contained in:
Dirk Mueller
2024-06-29 07:06:09 +00:00
committed by Git OBS Bridge
parent 8abec6f647
commit 4ce858e5ab
6 changed files with 213 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
fix-autodoc-tests-python-3117.patch
View File

@@ -1,68 +0,0 @@
Index: sphinx-7.2.6/tests/test_ext_autodoc_configs.py
===================================================================
--- sphinx-7.2.6.orig/tests/test_ext_autodoc_configs.py
+++ sphinx-7.2.6/tests/test_ext_autodoc_configs.py
@@ -1584,6 +1584,14 @@ def test_autodoc_typehints_format_fully_
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_autodoc_default_options(app):
+ if (
+ (3, 11, 7) <= sys.version_info < (3, 12)
+ or sys.version_info >= (3, 12, 1)
+ ):
+ list_of_weak_references = " list of weak references to the object"
+ else:
+ list_of_weak_references = " list of weak references to the object (if defined)"
+
# no settings
actual = do_autodoc(app, 'class', 'target.enums.EnumCls')
assert ' .. py:attribute:: EnumCls.val1' not in actual
@@ -1627,7 +1635,7 @@ 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
+ assert list_of_weak_references in actual
# :exclude-members: None - has no effect. Unlike :members:,
# :special-members:, etc. where None == "include all", here None means
@@ -1651,13 +1659,21 @@ 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
+ assert list_of_weak_references in actual
assert ' .. py:method:: CustomIter.snafucate()' in actual
assert ' Makes this snafucated.' in actual
@pytest.mark.sphinx('html', testroot='ext-autodoc')
def test_autodoc_default_options_with_values(app):
+ if (
+ (3, 11, 7) <= sys.version_info < (3, 12)
+ or sys.version_info >= (3, 12, 1)
+ ):
+ list_of_weak_references = " list of weak references to the object"
+ else:
+ list_of_weak_references = " list of weak references to the object (if defined)"
+
# with :members:
app.config.autodoc_default_options = {'members': 'val1,val2'}
actual = do_autodoc(app, 'class', 'target.enums.EnumCls')
@@ -1698,7 +1714,7 @@ def test_autodoc_default_options_with_va
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
+ assert list_of_weak_references not in actual
# with :exclude-members:
app.config.autodoc_default_options = {
@@ -1722,6 +1738,6 @@ def test_autodoc_default_options_with_va
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
+ assert list_of_weak_references not in actual
assert ' .. py:method:: CustomIter.snafucate()' not in actual
assert ' Makes this snafucated.' not in actual

16
fix-test-expectation-for-enum-rendering-on-python-3.12.3.patch
View File

@@ -1,16 +0,0 @@
Index: sphinx-7.2.6/tests/test_ext_autodoc.py
===================================================================
--- sphinx-7.2.6.orig/tests/test_ext_autodoc.py
+++ sphinx-7.2.6/tests/test_ext_autodoc.py
@@ -1407,7 +1407,10 @@ def test_enum_class(app):
options = {"members": None}
actual = do_autodoc(app, 'class', 'target.enums.EnumCls', options)
- if sys.version_info[:2] >= (3, 12):
+ if sys.version_info[:2] >= (3, 13) or sys.version_info[:3] >= (3, 12, 3):
+ args = ('(value, names=<not given>, *values, module=None, '
+ 'qualname=None, type=None, start=1, boundary=None)')
+ elif sys.version_info[:2] >= (3, 12):
args = ('(value, names=None, *values, module=None, '
'qualname=None, type=None, start=1, boundary=None)')
elif sys.version_info[:2] >= (3, 11):

203
python-Sphinx.changes
View File

@@ -1,3 +1,206 @@
-------------------------------------------------------------------
Sat Jun 29 07:05:01 UTC 2024 - Dirk Müller <dmueller@suse.com>
- update to 7.3.7:
* #12299: Defer loading themes defined via entry points until
their explicit use by the user or a child theme. Patch by
Adam Turner.
* #12305: Return the default value for theme.get_config() with
an unsupported theme configuration section. Patch by Adam
Turner.
* #12295: Re-export all AST types in the C and C++ domains.
Patch by Adam Turner.
* #12295: Re-export various objects from
sphinx.domains.python._annotations in sphinx.domains.python.
Patch by Jacob Chesslo and Adam Turner.
* #12295: Re-export various objects from
sphinx.domains.python._object in sphinx.domains.python. Patch
by Jacob Chesslo and Adam Turner.
* Handle cases when Any is not an instance of type. Patch by
Adam Turner.
* #12290: Fix a false-positive warning when setting a
configuration value with Any as the valid type to a type
other than the value's default. Patch by Adam Turner.
* Preload all themes defined via entry points. Patch by Adam
Turner.
* Fix a bad interaction between the 'Furo' theme and the new-
style for configuration values. Patch by Adam Turner.
* Require tomli on Python 3.10 and earlier. Patch by Adam
Turner.
* #11858: Increase the minimum supported version of Alabaster
to 0.7.14. Patch by Adam Turner.
* #11411: Support Docutils 0.21. Patch by Adam Turner.
* #12012: Use types-docutils instead of docutils-stubs.
* #11693: Support for old-style :file:`Makefile` and
:file:`make.bat` output in :program:`sphinx-quickstart`, and
the associated options :option:`!-M`, :option:`!-m`,
:option:`!--no-use-make-mode`, and :option:`!--use-make-
mode`.
* #11285: Direct access to
:attr:`!sphinx.testing.util.SphinxTestApp._status` or
:attr:`!sphinx.testing.util.SphinxTestApp._warning` is
deprecated. Use the public properties
:attr:`!sphinx.testing.util.SphinxTestApp.status` and
:attr:`!sphinx.testing.util.SphinxTestApp.warning` instead.
Patch by Bénédikt Tran.
* tests: :func:`!sphinx.testing.util.strip_escseq` is
deprecated in favour of
:func:`!sphinx.util.console.strip_colors`. Patch by Bénédikt
Tran.
* #12265: Support theme configuration via theme.toml.
* #11701: HTML Search: Adopt the new <search> element. Patch by
Bénédikt Tran.
* #11776: Add long option names to sphinx-build. Patch by Hugo
van Kemenade, Adam Turner, Bénédikt Tran, and Ezio Melotti.
* Organise the sphinx-build options into groups. Patch by Adam
Turner.
* #11855: Defer computation of configuration values. Patch by
Adam Turner.
* Add :no-search: as an alias of the :nosearch: metadata field.
Patch by Adam Turner.
* #11803: autodoc: Use an overriden __repr__() function in an
enum, if defined. Patch by Shengyu Zhang.
* #11825: Allow custom targets in the manpage role. Patch by
Nicolas Peugnet.
* #11892: Improved performance when resolving cross references
in the C++ domain. Patch by Rouslan Korneychuk.
* #11905: Add a :rst:dir:`versionremoved` directive. Patch by
Hugo van Kemenade, Adam Turner, and C.A.M. Gerlach.
* #11981: Improve rendering of signatures using slice syntax,
e.g., def foo(arg: np.float64[:,:]) -> None: ....
* The manpage builder now adds OSC 8 anchors to hyperlinks,
using the groff device control command.
* #11015: Change the text of the :rst:dir:`versionadded`
directive from New in [...] to Added in [...]. Patch by
Bénédikt Tran.
* #12131: Added :confval:`show_warning_types` configuration
option. Patch by Chris Sewell.
* #12193: Improve external warnings for unknown roles. In
particular, suggest related role names if an object type is
mistakenly used. Patch by Chris Sewell.
* Add public type alias
:class:`sphinx.util.typing.ExtensionMetadata`. This can be
used by extension developers to annotate the return type of
their setup function. Patch by Chris Sewell.
* #11668: Raise a useful error when theme.conf is missing.
Patch by Vinay Sajip.
* #11622: Ensure that the order of keys in searchindex.js is
deterministic. Patch by Pietro Albini.
* #11617: ANSI control sequences are stripped from the output
when writing to a warnings file with :option:`-w <sphinx-
build -w>`. Patch by Bénédikt Tran.
* #11666: Skip all hidden directories in
CatalogRepository.pofiles. Patch by Aryaz Eghbali.
* #9686: html builder: Fix MathJax lazy loading when equations
appear in titles. Patch by Bénédikt Tran.
* #11483: singlehtml builder: Fix MathJax lazy loading when the
index does not contain any math equations. Patch by Bénédikt
Tran.
* #11697: HTML Search: add 'noindex' meta robots tag. Patch by
James Addison.
* #11678: Fix a possible ZeroDivisionError in
sphinx.ext.coverage. Patch by Stephen Finucane.
* #11756: LaTeX: build error with recent TeXLive due to missing
substitutefont package (triggered if using fontenc with T2A
option and document language is not a Cyrillic one). Patch by
Jean-François B.
* #11675: Fix rendering of progression bars in environments
that do not support ANSI control sequences. Patch by Bénédikt
Tran.
* #11861: Whitelist more types with an incorrect __module__
attribute. Patch by Adam Turner.
* #11715: Apply tls_verify and tls_cacerts config to
ImageDownloader. Patch by Nick Touran.
* Allow hyphens in group names for :rst:dir:`productionlist`
cross-references. Patch by Adam Turner.
* #11433: Added the :confval:`linkcheck_allow_unauthorized`
configuration option. Set this option to False to report HTTP
401 (unauthorized) server responses as broken. Patch by James
Addison.
* #11868: linkcheck: added a distinct timeout reporting status
code. This can be enabled by setting
:confval:`linkcheck_report_timeouts_as_broken` to False.
Patch by James Addison.
* #11869: Refresh the documentation for the linkcheck_timeout
setting. Patch by James Addison.
* #11874: Configure a default 30-second value for
linkcheck_timeout. Patch by James Addison.
* #11886: Print the Jinja2 template path chain in
TemplateNotFound exceptions. Patch by Colin Marquardt.
* #11598: Do not use query components in URLs for assets in
EPUB rendering. Patch by David Runge.
* #11904: Support unary subtraction when parsing annotations.
Patch by James Addison.
* #11925: Blacklist the sphinxprettysearchresults extension;
the functionality it provides was merged into Sphinx v2.0.0.
Patch by James Addison.
* #11917: Fix rendering of annotated inherited members for
Python 3.9. Patch by Janet Carson.
* #11935: C Domain: Fix namespace-pop context. Patch by Frank
Dana.
* #11923: Avoid zombie processes when parallel builds fail.
Patch by Felix von Drigalski.
* #11353: Support enumeration classes inheriting from mixin or
data types. Patch by Bénédikt Tran.
* #11962: Fix target resolution when using :paramtype: fields.
Patch by Bénédikt Tran.
* #11944: Use anchor in search preview. Patch by Will Lachance.
* #12008: Fix case-sensitive lookup of std:label names in
intersphinx inventory. Patch by Michael Goerz.
* #11958: HTML Search: Fix partial matches overwriting full
matches. Patch by William Lachance.
* #11959: Fix multiple term matching when word appears in both
title and document. Patch by Will Lachance.
* #11474: Fix doctrees caching causing files not be rebuilt in
some cases, e.g., when :confval:`numfig` is True. Patch by
Bénédikt Tran.
* #11278: autodoc: Fix rendering of
:class:`functools.singledispatchmethod` combined with
:func:`@classmethod <classmethod>`. Patch by Bénédikt Tran.
* #11894: Do not add checksums to css files if building using
the htmlhelp builder. Patch by reduerK akiM.
* #12052: Remove <script> and <style> tags from the content of
search result summary snippets. Patch by James Addison.
* #11578: HTML Search: Order non-main index entries after other
results. Patch by Brad King.
* #12147: autosummary: Fix a bug whereby the wrong file
extension may be used, when multiple suffixes are specified
in :confval:`source_suffix`. Patch by Sutou Kouhei.
* #10786: improve the error message when a file to be copied
(e.g., an asset) is removed during Sphinx execution. Patch by
Bénédikt Tran.
* #12040: HTML Search: Ensure that document titles that are
partially-matched by the user search query are included in
search results. Patch by James Addison.
* #11970: singlehtml builder: make target URIs to be same-
document references in the sense of :rfc:`RFC 3986, §4.4
<3986#section-4.4>`, e.g., index.html#foo becomes #foo. Patch
by Eric Norige.
* #12271: Partially revert Docutils' r9562 to fix EPUB files.
Patch by Adam Turner.
* #12253: Escape reserved path characters in the remote images
post-transform download cache. Patch by James Addison and
Adam Turner.
* Reorganise tests into directories. Patch by Adam Turner.
* Clean up global state in SphinxTestApp. Patch by Adam Turner.
* #11285: :func:`!pytest.mark.sphinx` and
:class:`!sphinx.testing.util.SphinxTestApp` accept
warningiserror, keep_going and verbosity as keyword
arguments. Patch by Bénédikt Tran.
* #11285: :class:`!sphinx.testing.util.SphinxTestApp` status
and warning arguments are checked to be :class:`io.StringIO`
objects (the public API incorrectly assumed this without
checking it). Patch by Bénédikt Tran.
* Report the result of test_run_epubcheck as skipped instead of
success when either Java or epubcheck are not available.
* Use dynamic allocation of unused port numbers for the test
HTTP(S) servers. As a side-effect, this removes the need for
test server lockfiles, meaning that any remaining tests/test-
server.lock files can safely be deleted.
- drop fix-autodoc-tests-python-3117.patch,
fix-test-expectation-for-enum-rendering-on-python-3.12.3.patch:
upstream
-------------------------------------------------------------------
Mon Apr 22 10:10:49 UTC 2024 - Daniel Garcia <daniel.garcia@suse.com>

21
python-Sphinx.spec
View File

@@ -26,12 +26,12 @@
%endif
%{?sle15_python_module_pythons}
Name: python-Sphinx%{psuffix}
Version: 7.2.6
Version: 7.3.7
Release: 0
Summary: Python documentation generator
License: BSD-2-Clause
Group: Development/Languages/Python
URL: http://sphinx-doc.org
URL: https://www.sphinx-doc.org
Source: https://files.pythonhosted.org/packages/source/s/sphinx/sphinx-%{version}.tar.gz
# Provide intersphinx inventory offline, run update-intersphinx.sh
# https://docs.python.org/3/objects.inv
@@ -42,10 +42,6 @@ Source3: requests.inv
Source4: readthedocs.inv
Source5: update-intersphinx.sh
Source99: python-Sphinx.keyring
# PATCH-FIX-UPSTREAM: fix-autodoc-tests-python-3117.patch gh#sphinx-doc/sphinx#11793
Patch01: fix-autodoc-tests-python-3117.patch
# PATCH-FIX-UPSTREAM: fix-test-expectation-for-enum-rendering-on-python-3.12.3.patch gh#sphinx-doc/sphinx#12293
Patch02: fix-test-expectation-for-enum-rendering-on-python-3.12.3.patch
BuildRequires: %{python_module base}
BuildRequires: %{python_module flit-core}
BuildRequires: %{python_module pip}
@@ -323,8 +319,8 @@ export LC_ALL="C.utf8"
%if ! %{with test}
%files %{python_files} -f %{python_prefix}-sphinx.lang
%license LICENSE
%doc AUTHORS CHANGES README.rst
%license LICENSE.rst
%doc CHANGES.rst README.rst
%python_alternative %{_bindir}/sphinx-apidoc
%python_alternative %{_bindir}/sphinx-autogen
%python_alternative %{_bindir}/sphinx-build
@@ -336,24 +332,21 @@ export LC_ALL="C.utf8"
%dir %{python_sitelib}/sphinxcontrib
%files %{python_files latex}
%license LICENSE
%doc AUTHORS
%license LICENSE.rst
%{python_sitelib}/sphinx/texinputs/
%endif
%if %{with test}
%if 0%{?suse_version} > 1500
%files -n python-Sphinx-doc-man
%license LICENSE
%doc AUTHORS
%license LICENSE.rst
%{_mandir}/man1/sphinx-all.1%{?ext_man}
%{_mandir}/man1/sphinx-apidoc.1%{?ext_man}
%{_mandir}/man1/sphinx-build.1%{?ext_man}
%{_mandir}/man1/sphinx-quickstart.1%{?ext_man}
%files -n python-Sphinx-doc-html
%license LICENSE
%doc AUTHORS
%license LICENSE.rst
%dir %{_docdir}/python-Sphinx/
%{_docdir}/python-Sphinx/html/
%endif

BIN
sphinx-7.2.6.tar.gz (Stored with Git LFS)
View File

Binary file not shown.

3
sphinx-7.3.7.tar.gz Normal file
View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:a4a7db75ed37531c05002d56ed6948d4c42f473a36f46e1382b0bd76ca9627bc
size 7094808