Compare commits
1 Commits
Author | SHA256 | Date | |
---|---|---|---|
0d82a142bc |
68
fix-autodoc-tests-python-3117.patch
Normal file
68
fix-autodoc-tests-python-3117.patch
Normal file
@@ -0,0 +1,68 @@
|
||||
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
|
@@ -1,822 +1,3 @@
|
||||
-------------------------------------------------------------------
|
||||
Fri Mar 14 12:12:22 UTC 2025 - Markéta Machová <mmachova@suse.com>
|
||||
|
||||
- Update to 8.2.3
|
||||
* Correct spelling of highlighting_failure in warning sub-type.
|
||||
* Restore support for using sphinx.testing.path paths with
|
||||
sphinx.testing.fixtures
|
||||
* viewcode: Fix importing modules more than once.
|
||||
* Fix argument type for jieba.load_userdict().
|
||||
* Add workaround for nbsphinx implicit imports.
|
||||
* Ensure inline <script/> tags are written exactly once.
|
||||
* Define _StrPath.__radd__().
|
||||
* Fix _CurrentDocument membership testing with parent_symbol.
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Wed Mar 12 07:31:26 UTC 2025 - Daniel Garcia <daniel.garcia@suse.com>
|
||||
|
||||
- Add missing dependency python-roman-numerals
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Tue Mar 11 12:20:49 UTC 2025 - Dirk Müller <dmueller@suse.com>
|
||||
|
||||
- update to 8.2.0:
|
||||
* #13000: Drop Python 3.10 support.
|
||||
* #13044: Remove the internal and undocumented has_equations
|
||||
data from the :py:class:`!MathDomain` domain. The
|
||||
undocumented :py:meth:`!MathDomain.has_equations` method now
|
||||
unconditionally returns True. These are replaced by the
|
||||
has_maths_elements key of the page context dict. Patch by
|
||||
Adam Turner.
|
||||
* #13227: HTML output for sequences of keys in the
|
||||
:rst:role:`kbd` role no longer uses a <kbd class="kbd
|
||||
compound"> element to wrap the keys and separators, but
|
||||
places them directly in the relevant parent node. This means
|
||||
that CSS rulesets targeting kbd.compound or .kbd.compound
|
||||
will no longer have any effect. Patch by Adam Turner.
|
||||
* #13037: Deprecate the SingleHTMLBuilder.fix_refuris method.
|
||||
Patch by James Addison.
|
||||
* #13083, #13330: Un-deprecate sphinx.util.import_object. Patch
|
||||
by Matthias Geier.
|
||||
* #13173: Add a new duplicate_declaration warning type, with
|
||||
duplicate_declaration.c and duplicate_declaration.cpp
|
||||
subtypes. Patch by Julien Lecomte and Adam Turner.
|
||||
* #11824: linkcode: Allow extensions to add support for a
|
||||
domain by defining the keys that should be present. Patch by
|
||||
Nicolas Peugnet.
|
||||
* #13144: Add a class option to the :rst:dir:`autosummary`
|
||||
directive. Patch by Tim Hoffmann.
|
||||
* #13146: Napoleon: Unify the type preprocessing logic to allow
|
||||
Google-style docstrings to use the optional and default
|
||||
keywords. Patch by Chris Barrick.
|
||||
* #13227: Implement the :rst:role:`kbd` role as a SphinxRole.
|
||||
Patch by Adam Turner.
|
||||
* #13065: Enable colour by default in when running on CI. Patch
|
||||
by Adam Turner.
|
||||
* #13230: Allow supressing warnings from the :rst:dir:`toctree`
|
||||
directive when a glob pattern doesn't match any documents,
|
||||
via the new toc.empty_glob warning sub-type. Patch by Slawek
|
||||
Figiel.
|
||||
* #9732: Add the new autodoc.mocked_object warnings sub-type.
|
||||
Patch by Cyril Roelandt.
|
||||
* #7630, #4824: autodoc: Use :file:`.pyi` type stub files to
|
||||
auto-document native modules. Patch by Adam Turner, partially
|
||||
based on work by Allie Fitter.
|
||||
* #12975: Enable configuration of trailing commas in multi-line
|
||||
signatures in the Python and Javascript domains, via the new
|
||||
:confval:`python_trailing_comma_in_multi_line_signatures` and
|
||||
:confval:`javascript_trailing_comma_in_multi_line_signatures`
|
||||
configuration options.
|
||||
* #13264: Rename the :rst:dir:`math` directive's nowrap option
|
||||
to :rst:dir:`math:no-wrap`. Patch by Adam Turner.
|
||||
* #13269: Added the option to disable the use of type comments
|
||||
in via the new :confval:`autodoc_use_type_comments` option,
|
||||
which defaults to True for backwards compatibility. The
|
||||
default will change to False in Sphinx 10. Patch by Adam
|
||||
Turner.
|
||||
* #9732: Add the new ref.any warnings sub-type to allow
|
||||
suppressing the ambiguous 'any' cross-reference warning.
|
||||
Patch by Simão Afonso and Adam Turner.
|
||||
* #13272: The Python and JavaScript module directives now
|
||||
support the :no-index-entry: option. Patch by Adam Turner.
|
||||
* #12233: autodoc: Allow directives to use :no-index-entry: and
|
||||
include the :no-index: and :no-index-entry: options within
|
||||
:confval:`autodoc_default_options`. Patch by Jonny Saunders
|
||||
and Adam Turner.
|
||||
* #13172: Add support for short signatures in autosummary.
|
||||
Patch by Tim Hoffmann.
|
||||
* #13271: Change the signature prefix for abstract methods in
|
||||
the Python domain to abstractmethod from abstract. Patch by
|
||||
Adam Turner.
|
||||
* #13271: Support the :abstract: option for classes, methods,
|
||||
and properties in the Python domain. Patch by Adam Turner.
|
||||
* #12507: Add the :ref:`collapsible <collapsible-admonitions>`
|
||||
option to admonition directives. Patch by Chris Sewell.
|
||||
* #8191, #8159: Add :rst:dir:`inheritance-diagram:include-
|
||||
subclasses` option to the :rst:dir:`inheritance-diagram`
|
||||
directive. Patch by Walter Dörwald.
|
||||
* #11995: autodoc: Add support for
|
||||
:confval:`python_display_short_literal_types`. Patch by
|
||||
Bénédikt Tran and Adam Turner.
|
||||
* #13163: Always print the full context when Sphinx encounters
|
||||
an internal error. Patch by Kevin Deldycke and Adam Turner.
|
||||
* #13105: Introduce the :rst:role:`py:deco` role to cross-
|
||||
reference decorator functions and methods in the Python
|
||||
domain. Patch by Adam Turner.
|
||||
* #9169: Add the :confval:`intersphinx_resolve_self` option to
|
||||
resolve an intersphinx reference to the current project.
|
||||
Patch by Jakob Lykke Andersen and Adam Turner.
|
||||
* #11280: Add ability to skip a particular section using the
|
||||
no-search class. Patch by Will Lachance.
|
||||
* #13326: Remove hardcoding from handling
|
||||
:class:`~sphinx.addnodes.productionlist` nodes in all
|
||||
writers, to improve flexibility. Patch by Adam Turner.
|
||||
* #13335: Use misc.highlighting_failure subtype for Pygments
|
||||
unknown lexers. Patch by Bart Kamphorst.
|
||||
* #13354: Insert abbreviation nodes (hover text) for
|
||||
positional- and keyword-only separators in Python signatures.
|
||||
Patch by Adam Turner.
|
||||
* #13333: Add the :mod:`sphinx.ext.apidoc` extension, to
|
||||
automate API documentation generation from Python modules.
|
||||
Patch by Chris Sewell and Adam Turner.
|
||||
* #12463: autosummary: Respect an empty module __all__. Patch
|
||||
by Valentin Pratz
|
||||
* #13060: HTML Search: use Map to store per-file term scores.
|
||||
Patch by James Addison
|
||||
* #13130: LaTeX docs: pdflatex index creation may fail for
|
||||
index entries in French. See :confval:`latex_use_xindy`.
|
||||
Patch by Jean-François B.
|
||||
* #13152: LaTeX: fix a typo from v7.4.0 in a default for
|
||||
\sphinxboxsetup. Patch by Jean-François B.
|
||||
* #13096: HTML Search: check that query terms exist as
|
||||
properties in term indices before accessing them.
|
||||
* #11233: linkcheck: match redirect URIs against
|
||||
:confval:`linkcheck_ignore` by overriding session-level
|
||||
requests.get_redirect_target.
|
||||
* #13195: viewcode: Fix issue where import paths differ from
|
||||
the directory structure. Patch by Ben Egan and Adam Turner.
|
||||
* #13188: autodoc: fix detection of class methods implemented
|
||||
in C. Patch by Bénédikt Tran.
|
||||
* #1810: Always copy static files when building, regardless of
|
||||
whether any documents have changed since the previous build.
|
||||
Patch by Adam Turner.
|
||||
* #13201: autodoc: fix ordering of members when using groupwise
|
||||
for :confval:`autodoc_member_order`. Class methods are now
|
||||
rendered before static methods, which themselves are rendered
|
||||
before regular methods and attributes. Patch by Bénédikt
|
||||
Tran.
|
||||
* #12975: Avoid rendering a trailing comma in C and C++ multi-
|
||||
line signatures.
|
||||
* #13178: autodoc: Fix resolution for pathlib types. Patch by
|
||||
Adam Turner.
|
||||
* #13136: autodoc: Correctly handle multiple inheritance. Patch
|
||||
by Pavel Holica
|
||||
* #13273, #13318: Properly convert command-line overrides for
|
||||
Boolean types. Patch by Adam Turner.
|
||||
* #13302, #13319: Use the correct indentation for continuation
|
||||
lines in :rst:dir:`productionlist` directives. Patch by Adam
|
||||
Turner.
|
||||
* #13328: Fix parsing of PEP 695 functions with return
|
||||
annotations. Patch by Bénédikt Tran. Initial work by Arash
|
||||
Badie-Modiri.
|
||||
* #13224: Correctness fixup for test_html_multi_line_copyright.
|
||||
Patch by Colin Watson, applied by James Addison.
|
||||
- drop pygments.patch (upstream)
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Fri Jan 17 11:52:23 UTC 2025 - Markéta Machová <mmachova@suse.com>
|
||||
|
||||
- Add pygments.patch to fix tests with Pygments 2.19
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Wed Nov 20 17:51:19 UTC 2024 - Dirk Müller <dmueller@suse.com>
|
||||
|
||||
- update to 8.1.3:
|
||||
* #13013: Restore support for :func:`!cut_lines` with no object
|
||||
type. Patch by Adam Turner.
|
||||
* #13012: Expose :exc:`sphinx.errors.ExtensionError` in
|
||||
sphinx.util for backwards compatibility. This will be removed
|
||||
in Sphinx 9, as exposing the exception in sphinx.util was
|
||||
never intentional. :exc:`!ExtensionError` has been part of
|
||||
sphinx.errors since Sphinx 0.9. Patch by Adam Turner.
|
||||
* #13006: Use the preferred https://www.cve.org/ URL for the
|
||||
:rst:role:`:cve: <cve>` role. Patch by Hugo van Kemenade.
|
||||
* #13007: LaTeX: Improve resiliency when the required
|
||||
fontawesome or fontawesome5 packages are not installed. Patch
|
||||
by Jean-François B.
|
||||
* #12756: Add lower-bounds to the sphinxcontrib-* dependencies.
|
||||
Patch by Adam Turner.
|
||||
* #12833: Update the LaTeX parskip package from 2001 to 2018.
|
||||
Patch by Jean-François B.
|
||||
* #12763: Remove unused internal class sphinx.util.Tee. Patch
|
||||
by Adam Turner.
|
||||
* #12822: LaTeX: for Unicode engines, the :ref:`fvset` default
|
||||
is changed to '\fvset{fontsize=auto}' from
|
||||
'\fvset{fontsize=\small}'. Code-blocks are unchanged as
|
||||
FreeMono is now loaded with Scale=0.9. An adjustment to
|
||||
existing projects is needed only if they used a custom
|
||||
:ref:`fontpkg` configuration and did not set :ref:`fvset`.
|
||||
Patch by Jean-François B.
|
||||
* #12875: Disable smartquotes for languages: zh_CN and zh_TW by
|
||||
default. Patch by A. Rafey Khan.
|
||||
* #12762: Deprecate sphinx.util.import_object. Use
|
||||
:py:func:`importlib.import_module` instead. Patch by Adam
|
||||
Turner.
|
||||
* #12766: Deprecate sphinx.util.FilenameUniqDict and
|
||||
sphinx.util.DownloadFiles. Patch by Adam Turner.
|
||||
* #11328: Mention evaluation of templated content during
|
||||
production of static output files. Patch by James Addison.
|
||||
* #12704: LaTeX: make :dudir:`contents <table-of-contents>`,
|
||||
:dudir:`topic`, and :dudir:`sidebar` directives separately
|
||||
customizable for PDF output. Patch by Jean-François B. and
|
||||
Bénédikt Tran.
|
||||
* #12474: Support type-dependent search result highlighting via
|
||||
CSS. Patch by Tim Hoffmann.
|
||||
* #12652: LaTeX: Add :confval:`math_numsep` support to latex
|
||||
builder. Patch by Thomas Fanning and Jean-François B.
|
||||
* #12743: No longer exit on the first warning when
|
||||
:option:`--fail-on-warning <sphinx-build --fail-on-warning>`
|
||||
is used. Instead, exit with a non-zero status if any warnings
|
||||
were generated during the build. Patch by Adam Turner.
|
||||
* #12743: Add :option:`sphinx-build --exception-on-warning`, to
|
||||
raise an exception when warnings are emitted during the
|
||||
build. Patch by Adam Turner and Jeremy Maitin-Shepard.
|
||||
* #12907: Add :confval:`html_last_updated_use_utc` to allow
|
||||
using universal time (GMT/UTC) instead of local time for the
|
||||
date-time supplied to :confval:`html_last_updated_fmt`. Patch
|
||||
by Adam Turner.
|
||||
* #12910: Copyright entries now support the '%Y' placeholder to
|
||||
substitute the current year. This is helpful for reducing the
|
||||
reliance on Python modules such as :py:mod:`time` or
|
||||
:py:mod:`datetime` in :file:`conf.py`. See :ref:`the docs
|
||||
<config-copyright>` for further detail. Patch by Adam Turner.
|
||||
* #11781: Add roles for referencing CVEs (:rst:role:`:cve:
|
||||
<cve>`) and CWEs (:rst:role:`:cwe: <cwe>`). Patch by Hugo van
|
||||
Kemenade.
|
||||
* #11809: Improve the formatting for RFC section anchors. Patch
|
||||
by Jakub Stasiak and Adam Turner.
|
||||
* #12852: Support a :attr:`.Builder.supported_linkcode`
|
||||
attribute for builders to enable use of
|
||||
:mod:`sphinx.ext.linkcode`-generated references. Patch by
|
||||
James Knight.
|
||||
* #12949: Print configuration options that differ from the
|
||||
pickled environment. This can be helpful in diagnosing the
|
||||
cause of a full rebuild. Patch by Adam Turner.
|
||||
* #12514: intersphinx: fix the meaning of a negative value for
|
||||
:confval:`intersphinx_cache_limit`. Patch by Shengyu Zhang.
|
||||
* #12722: LaTeX: avoid TeX reporting Overfull \hbox from too
|
||||
long strings in a codeline when the problem has actually been
|
||||
solved thanks to :ref:`latexsphinxsetupforcewraps`. Patch by
|
||||
Jean-François B.
|
||||
* #12730: The UnreferencedFootnotesDetector transform has been
|
||||
improved to more consistently detect unreferenced footnotes.
|
||||
Note, the priority of the transform has been changed from 200
|
||||
to 622, so that it now runs after the docutils Footnotes
|
||||
resolution transform. Patch by Chris Sewell.
|
||||
* #12778: LaTeX: let :ref:`'sphinxsetup' <latexsphinxsetup>`
|
||||
div.topic_box-shadow key if used with only one dimension set
|
||||
both x-offset and y-offset as per documentation. Patch by
|
||||
Jean-François B.
|
||||
* #12587: Do not warn when potential ambiguity detected during
|
||||
Intersphinx resolution occurs due to duplicate targets that
|
||||
differ case-insensitively. Patch by James Addison.
|
||||
* #12639: Fix singular and plural search results text. Patch by
|
||||
Hugo van Kemenade.
|
||||
* #12645: Correctly support custom gettext output templates.
|
||||
Patch by Jeremy Bowman.
|
||||
* #12717: LaTeX: let :option:`-q <sphinx-build -q>` (quiet)
|
||||
option for :program:`sphinx-build -M latexpdf` or
|
||||
:program:`make latexpdf` (O=-q) get passed to
|
||||
:program:`latexmk`. Let :option:`-Q <sphinx-build -Q>`
|
||||
(silent) apply as well to the PDF build phase. Patch by Jean-
|
||||
François B.
|
||||
* #12744: LaTeX: Classes injected by a custom interpreted text
|
||||
role now give rise to nested \DUrole's, rather than a single
|
||||
one with comma separated classes. Patch by Jean-François B.
|
||||
* #12831: LaTeX: avoid large voids sometimes occurring at page
|
||||
bottoms. Patch by Jean-François B.
|
||||
* #11970, #12551: 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.
|
||||
(note: continuation of a partial fix added in Sphinx 7.3.0)
|
||||
Patch by James Addison (with reference to prior work by Eric
|
||||
Norige).
|
||||
* #12735: Fix PEP 695 generic classes LaTeX output formatting.
|
||||
Patch by Jean-François B. and Bénédikt Tran.
|
||||
* #12782: intersphinx: fix double forward slashes when
|
||||
generating the inventory file URL (user-defined base URL of
|
||||
an intersphinx project are left untouched even if they end
|
||||
with double forward slashes). Patch by Bénédikt Tran.
|
||||
* #12796: Enable parallel reading if requested, even if there
|
||||
are fewer than 6 documents. Patch by Matthias Geier.
|
||||
* #12844: Restore support for :noindex: for the
|
||||
:rst:dir:`js:module` and :rst:dir:`py:module` directives.
|
||||
Patch by Stephen Finucane.
|
||||
* #12916: Restore support for custom templates named with the
|
||||
legacy _t suffix during apidoc RST rendering (regression in
|
||||
7.4.0). Patch by James Addison.
|
||||
* #12451: Only substitute copyright notice years with values
|
||||
from SOURCE_DATE_EPOCH for entries that match the current
|
||||
system clock year, and disallow substitution of future years.
|
||||
Patch by James Addison and Adam Turner.
|
||||
* #12905: intersphinx: fix flipped use of
|
||||
:confval:`intersphinx_cache_limit`, which always kept the
|
||||
cache for positive values, and always refreshed it for
|
||||
negative ones. Patch by Nico Madysa.
|
||||
* #12888: Add a warning when document is included in multiple
|
||||
toctrees and ensure deterministic resolution of global
|
||||
toctree in parallel builds by choosing the lexicographically
|
||||
greatest parent document. Patch by A. Rafey Khan
|
||||
* #12995: Significantly improve performance when building the
|
||||
search index for Chinese languages. Patch by Adam Turner.
|
||||
* #12767: :py:meth:`.Builder.write` is typed as final, meaning
|
||||
that the :event:`write-started` event may be relied upon by
|
||||
extensions. A new :py:meth:`.Builder.write_documents` method
|
||||
has been added to control how documents are written. This is
|
||||
intended for builders that do not output a file for each
|
||||
document. Patch by Adam Turner.
|
||||
* #12141: Migrate from the deprecated karma JavaScript test
|
||||
framework to the actively-maintained jasmine framework. Test
|
||||
coverage is unaffected. Patch by James Addison.
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Sun Sep 1 14:31:32 UTC 2024 - Christoph G <foss@grueninger.de>
|
||||
|
||||
- update to 8.0.2
|
||||
* #12633: Drop Python 3.9 support.
|
||||
* Remove deprecated functions from sphinx.util:
|
||||
+ Removed sphinx.util.path_stabilize (use sphinx.util.osutil.path_stabilize).
|
||||
+ Removed sphinx.util.display_chunk (use sphinx.util.display.display_chunk).
|
||||
+ Removed sphinx.util.status_iterator (use sphinx.util.display.status_iterator).
|
||||
+ Removed sphinx.util.SkipProgressMessage (use
|
||||
sphinx.util.display.SkipProgressMessage).
|
||||
+ Removed sphinx.util.progress_message (use
|
||||
sphinx.util.display.progress_message).
|
||||
+ Removed sphinx.util.epoch_to_rfc1123 (use sphinx.http_date.epoch_to_rfc1123).
|
||||
+ Removed sphinx.util.rfc1123_to_epoch (use sphinx.http_date.rfc1123_to_epoch).
|
||||
+ Removed sphinx.util.save_traceback (use sphinx.exceptions.save_traceback).
|
||||
+ Removed sphinx.util.format_exception_cut_frames (use
|
||||
sphinx.exceptions.format_exception_cut_frames).
|
||||
+ Removed sphinx.util.xmlname_checker (use
|
||||
sphinx.builders.epub3._XML_NAME_PATTERN).
|
||||
+ Removed sphinx.util.osutil.cd() (use contextlib.chdir()).
|
||||
+ Removed sphinx.util.typing.stringify() (use
|
||||
sphinx.util.typing.stringify_annotation()).
|
||||
* #12593: Raise an error for invalid html_sidebars values.
|
||||
* #12593: Raise an error in Theme.get_config() for invalid sections.
|
||||
* #11693: Remove support for old-style Makefile and make.bat output in
|
||||
sphinx-quickstart.
|
||||
* #11693: Remove the --no-use-make-mode, -M, --use-make-mode, and -m options
|
||||
from sphinx-quickstart.
|
||||
* Removed the tuple interface to sphinx.ext.autodoc.ObjectMember.
|
||||
* #12630: Sphinx 8 makes two changes to the linkcheck configuration defaults:
|
||||
+ linkcheck_allow_unauthorized is now False by default.
|
||||
+ linkcheck_report_timeouts_as_broken is now False by default.
|
||||
* #12597: Change the default of show_warning_types from False to True.
|
||||
* #12083: Remove support for the old (2008–2010) Sphinx 0.5 and Sphinx 0.6
|
||||
intersphinx_mapping format.
|
||||
* #12096: Do not overwrite user-supplied files when copying assets unless
|
||||
forced with force=True.
|
||||
* #12646: Remove sphinx.util.inspect.isNewType(). Use isinstance(obj,
|
||||
typing.NewType) instead on Python 3.10 and newer.
|
||||
* Remove the long-deprecated (since Sphinx 2) alias to VersionChange in
|
||||
sphinx.directives.other (Deprecated since Sphinx 2). Use
|
||||
sphinx.domains.changeset.VersionChange directly.
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Thu Jul 18 07:27:41 UTC 2024 - Dirk Müller <dmueller@suse.com>
|
||||
|
||||
- update to 7.4.5:
|
||||
* #12593, #12600: Revert coercing the type of selected
|
||||
:confval:`html_sidebars` values to a list. Log an error
|
||||
message when string values are detected. Patch by Adam
|
||||
Turner.
|
||||
* #12594: LaTeX: since 7.4.0, :rst:dir:`seealso` and other
|
||||
"light" admonitions now break PDF builds if they contain a
|
||||
:dudir:`figure` directive; and also if they are contained in
|
||||
a table cell (rendered by tabulary). Patch by Jean-François
|
||||
B.
|
||||
* #12585, #12586: Do not warn when an intersphinx inventory
|
||||
contains case-insensitively ambiguous duplicate items. Patch
|
||||
by James Addison.
|
||||
* #12582: Restore support for list-styled
|
||||
:confval:`source_suffix` values with extensions that register
|
||||
parsers. Patch by Adam Turner.
|
||||
* #12580, #12583: Resolve failures with the C domain on
|
||||
incremental builds with Sphinx 7.3.7 and earlier. Patch by
|
||||
Adam Turner.
|
||||
* Fix invalid HTML when a rubric node with invalid heading-
|
||||
level is used. Patch by Adam Turner.
|
||||
* #12579, #12581: Restore support for typing.ParamSpec in
|
||||
autodoc. Patch by Adam Turner.
|
||||
* #12555: Drop Docutils 0.18.1 and Docutils 0.19 support. Patch
|
||||
by Adam Turner.
|
||||
* LaTeX: the xcolor package is now required (but is for example
|
||||
part of Ubuntu texlive-latex-recommended which has always
|
||||
been required).
|
||||
* LaTeX: the fontawesome5 LaTeX package is needed for the
|
||||
default choices of icons now used in admonition titles in PDF
|
||||
output; but if unavailable the PDF build will simply silently
|
||||
omit rendering such icons. Check the documentation of the
|
||||
iconpackage key of :ref:`'sphinxsetup' <latexsphinxsetup>`
|
||||
for more.
|
||||
* LaTeX: the sphinxlightbox environment is not used anymore,
|
||||
all types of admonitions use (by default) only
|
||||
sphinxheavybox.
|
||||
* #11165: Support the officially recommended .jinja suffix for
|
||||
template files. Patch by James Addison and Adam Turner
|
||||
* #11165: Support the officially recommended .jinja suffix for
|
||||
template files. Patch by James Addison and Adam Turner
|
||||
* #12325: Flatten Union[Literal[T], Literal[U], ...] to
|
||||
Literal[T, U, ...] when turning annotations into strings.
|
||||
Patch by Adam Turner.
|
||||
* #12325: Flatten Union[Literal[T], Literal[U], ...] to
|
||||
Literal[T, U, ...] when turning annotations into strings.
|
||||
Patch by Adam Turner.
|
||||
* #12319: sphinx.ext.extlinks: Add extlink-{name} CSS class to
|
||||
links. Patch by Hugo van Kemenade.
|
||||
* #12319: sphinx.ext.extlinks: Add extlink-{name} CSS class to
|
||||
links. Patch by Hugo van Kemenade.
|
||||
* #12387: Improve CLI progress message, when copying assets.
|
||||
Patch by INADA Nakoi and Bénédikt Tran.
|
||||
* #12387: Improve CLI progress message, when copying assets.
|
||||
Patch by INADA Nakoi and Bénédikt Tran.
|
||||
* #12361: Add :attr:`.BuildEnvironment.parser`. Patch by Chris
|
||||
Sewell.
|
||||
* #12361: Add :attr:`.BuildEnvironment.parser`. Patch by Chris
|
||||
Sewell.
|
||||
* #12358: Add :attr:`.Sphinx.fresh_env_used`. Patch by Chris
|
||||
Sewell.
|
||||
* #12358: Add :attr:`.Sphinx.fresh_env_used`. Patch by Chris
|
||||
Sewell.
|
||||
* #12329: Add detection of ambiguous std:label and std:term
|
||||
references during loading and resolution of Intersphinx
|
||||
targets. Patch by James Addison.
|
||||
* #12329: Add detection of ambiguous std:label and std:term
|
||||
references during loading and resolution of Intersphinx
|
||||
targets. Patch by James Addison.
|
||||
* #12422: Do not duplicate "navigation" in aria-label of built-
|
||||
in themes. Patch by Thomas Weißschuh
|
||||
* #12422: Do not duplicate "navigation" in aria-label of built-
|
||||
in themes. Patch by Thomas Weißschuh
|
||||
* #12421: Include project name in logo_alt of built-in themes.
|
||||
Patch by Thomas Weißschuh
|
||||
* #12421: Include project name in logo_alt of built-in themes.
|
||||
Patch by Thomas Weißschuh
|
||||
* #12448: Add :option:`sphinx-apidoc --remove-old` option.
|
||||
Patch by Chris Sewell.
|
||||
* #12448: Add :option:`sphinx-apidoc --remove-old` option.
|
||||
Patch by Chris Sewell.
|
||||
* #12456: Add :option:`sphinx-autogen --remove-old` option.
|
||||
Patch by Chris Sewell.
|
||||
* #12456: Add :option:`sphinx-autogen --remove-old` option.
|
||||
Patch by Chris Sewell.
|
||||
* #12479: Add warning subtype toc.no_title. Patch by Ondřej
|
||||
Navrátil.
|
||||
* #12479: Add warning subtype toc.no_title. Patch by Ondřej
|
||||
Navrátil.
|
||||
* #12492: Add helper methods for parsing reStructuredText
|
||||
content into nodes from within a directive. :py:meth:`~sphin
|
||||
x.util.docutils.SphinxDirective.parse_content_to_nodes()`
|
||||
parses the directive's content and returns a list of Docutils
|
||||
nodes. :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_
|
||||
text_to_nodes()` parses the provided text and returns a list
|
||||
of Docutils nodes. :py:meth:`~sphinx.util.docutils.SphinxDire
|
||||
ctive.parse_inline()` parses the provided text into inline
|
||||
elements and text nodes. Patch by Adam Turner.
|
||||
* #12492: Add helper methods for parsing reStructuredText
|
||||
content into nodes from within a directive.
|
||||
* :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_content
|
||||
_to_nodes()` parses the directive's content and returns a
|
||||
list of Docutils nodes.
|
||||
* :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_text_to
|
||||
_nodes()` parses the provided text and returns a list of
|
||||
Docutils nodes.
|
||||
* :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_inline(
|
||||
)` parses the provided text into inline elements and text
|
||||
nodes.
|
||||
* Patch by Adam Turner.
|
||||
* #12258: Support typing_extensions.Unpack Patch by Bénédikt
|
||||
Tran and Adam Turner.
|
||||
* #12258: Support typing_extensions.Unpack Patch by Bénédikt
|
||||
Tran and Adam Turner.
|
||||
* #12524: Add a class option to the :rst:dir:`toctree`
|
||||
directive. Patch by Tim Hoffmann.
|
||||
* #12524: Add a class option to the :rst:dir:`toctree`
|
||||
directive. Patch by Tim Hoffmann.
|
||||
* #12536: Add the :rst:dir:`confval` directive. Patch by Adam
|
||||
Turner.
|
||||
* #12536: Add the :rst:dir:`confval` directive. Patch by Adam
|
||||
Turner.
|
||||
* #12537: :confval:`c_id_attributes`,
|
||||
:confval:`c_paren_attributes`, :confval:`cpp_id_attributes`,
|
||||
and :confval:`cpp_paren_attributes` can now be a tuple of
|
||||
strings. :confval:`c_extra_keywords`,
|
||||
:confval:`gettext_additional_targets`,
|
||||
:confval:`html_domain_indices`,
|
||||
:confval:`latex_domain_indices`, and
|
||||
:confval:`texinfo_domain_indices`, can now be a set of
|
||||
strings. Patch by Adam Turner.
|
||||
* #12537: :confval:`c_id_attributes`,
|
||||
:confval:`c_paren_attributes`, :confval:`cpp_id_attributes`,
|
||||
and :confval:`cpp_paren_attributes` can now be a tuple of
|
||||
strings. :confval:`c_extra_keywords`,
|
||||
:confval:`gettext_additional_targets`,
|
||||
:confval:`html_domain_indices`,
|
||||
:confval:`latex_domain_indices`, and
|
||||
:confval:`texinfo_domain_indices`, can now be a set of
|
||||
strings. Patch by Adam Turner.
|
||||
* #12523: Added configuration option, :confval:`math_numsep`,
|
||||
to define the separator for math numbering. Patch by Thomas
|
||||
Fanning
|
||||
* #12523: Added configuration option, :confval:`math_numsep`,
|
||||
to define the separator for math numbering. Patch by Thomas
|
||||
Fanning
|
||||
* #11592: Add :confval:`coverage_modules` to the coverage
|
||||
builder to allow explicitly specifying which modules should
|
||||
be documented. Patch by Stephen Finucane.
|
||||
* #11592: Add :confval:`coverage_modules` to the coverage
|
||||
builder to allow explicitly specifying which modules should
|
||||
be documented. Patch by Stephen Finucane.
|
||||
* #7896, #11989: Add a :rst:dir:`py:type` directive for
|
||||
documenting type aliases, and a :rst:role:`py:type` role for
|
||||
linking to them. Patch by Ashley Whetter.
|
||||
* #7896, #11989: Add a :rst:dir:`py:type` directive for
|
||||
documenting type aliases, and a :rst:role:`py:type` role for
|
||||
linking to them. Patch by Ashley Whetter.
|
||||
* #12549: Add optional description argument to
|
||||
:meth:`.Sphinx.add_config_value`. Patch by Chris Sewell.
|
||||
* #12549: Add optional description argument to
|
||||
:meth:`.Sphinx.add_config_value`. Patch by Chris Sewell.
|
||||
* #6792: Prohibit module import cycles in
|
||||
:mod:`sphinx.ext.autosummary`. Patch by Trevor Bekolay.
|
||||
* #6792: Prohibit module import cycles in
|
||||
:mod:`sphinx.ext.autosummary`. Patch by Trevor Bekolay.
|
||||
* #12508: LaTeX: Revamped styling of all admonitions, with
|
||||
addition of a title row with icon. Patch by Jean-François B.
|
||||
* #12508: LaTeX: Revamped styling of all admonitions, with
|
||||
addition of a title row with icon. Patch by Jean-François B.
|
||||
* #11773: Display :py:class:`~typing.Annotated` annotations
|
||||
with their metadata in the Python domain. Patch by Adam
|
||||
Turner and David Stansby.
|
||||
* #11773: Display :py:class:`~typing.Annotated` annotations
|
||||
with their metadata in the Python domain. Patch by Adam
|
||||
Turner and David Stansby.
|
||||
* #12506: Add heading-level option to :rst:dir:`rubric`
|
||||
directive. Patch by Chris Sewell.
|
||||
* #12506: Add heading-level option to :rst:dir:`rubric`
|
||||
directive. Patch by Chris Sewell.
|
||||
* #12567: Add the :event:`write-started` event. Patch by Chris
|
||||
Sewell.
|
||||
* #12567: Add the :event:`write-started` event. Patch by Chris
|
||||
Sewell.
|
||||
* #12314: Properly format collections.abc.Callable in
|
||||
annotations. Patch by Adam Turner.
|
||||
* #12162: Fix a performance regression in the C domain that has
|
||||
been present since version 3.0.0. Patch by Donald Hunter.
|
||||
* #12320: Fix removal of anchors from search summaries
|
||||
(regression in 7.3.0). Patch by Will Lachance.
|
||||
* #12251: Fix merge_domaindata() in sphinx.ext.duration. Patch
|
||||
by Matthias Geier.
|
||||
* #12224: Properly detect WebP files. Patch by Benjamin Cabé.
|
||||
* #12380: LaTeX: Footnote mark sometimes indicates Page N where
|
||||
N is the current page number and the footnote does appear on
|
||||
that same page. Patch by Jean-François B.
|
||||
* #12410: LaTeX: for French and 'lualatex' as
|
||||
:confval:`latex_engine` polyglossia and not babel is used
|
||||
(contrarily to 'xelatex'). Patch by Jean-François B.
|
||||
* #12416: Ensure that configuration setting aliases are always
|
||||
synchronised when one value or the other is modified. Patch
|
||||
by Bénédikt Tran.
|
||||
* #12220: Fix loading custom template translations for en
|
||||
locale. Patch by Nicolas Peugnet.
|
||||
* #12459: Add valid-type arguments to the
|
||||
linkcheck_rate_limit_timeout configuration setting. Patch by
|
||||
James Addison.
|
||||
* #12331: Resolve data-URI-image-extraction regression from
|
||||
v7.3.0 affecting builders without native support for data-
|
||||
URIs in their output format. Patch by James Addison.
|
||||
* #12494: Fix invalid genindex.html file produced with
|
||||
translated docs (regression in 7.1.0). Patch by Nicolas
|
||||
Peugnet.
|
||||
* #11961: Omit anchor references from document title entries in
|
||||
the search index, removing duplication of search results.
|
||||
Patch by James Addison.
|
||||
* #12425: Use Docutils' SVG processing in the HTML builder and
|
||||
remove Sphinx's custom logic. Patch by Tunç Başar Köse.
|
||||
* #12391: Adjust scoring of matches during HTML search so that
|
||||
document main titles tend to rank higher than subsection
|
||||
titles. In addition, boost matches on the name of programming
|
||||
domain objects relative to title/subtitle matches. Patch by
|
||||
James Addison and Will Lachance.
|
||||
* #9634: Do not add a fallback language by stripping the
|
||||
country code. Patch by Alvin Wong.
|
||||
* #12352: Add domain objects to the table of contents in the
|
||||
same order as defined in the document. Previously, each
|
||||
domain used language-specific nesting rules, which removed
|
||||
control from document authors. Patch by Jakob Lykke Andersen
|
||||
and Adam Turner.
|
||||
* #11041: linkcheck: Ignore URLs that respond with non-Unicode
|
||||
content. Patch by James Addison.
|
||||
* #12543: Fix PEP 695 formatting for LaTeX output. Patch by
|
||||
Bénédikt Tran.
|
||||
* karma: refactor HTML search tests to use fixtures generated
|
||||
by Sphinx. Patch by James Addison.
|
||||
|
||||
-------------------------------------------------------------------
|
||||
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>
|
||||
|
||||
- Add fix-test-expectation-for-enum-rendering-on-python-3.12.3.patch
|
||||
gh#sphinx-doc/sphinx#12293, bsc#1223128
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Wed Feb 28 13:53:54 UTC 2024 - Ana Guerrero <ana.guerrero@suse.com>
|
||||
|
||||
- Disable test test_ext_imgconverter.
|
||||
|
||||
-------------------------------------------------------------------
|
||||
Wed Dec 20 12:48:53 UTC 2023 - Daniel Garcia <daniel.garcia@suse.com>
|
||||
|
||||
|
@@ -1,7 +1,7 @@
|
||||
#
|
||||
# spec file for package python-Sphinx
|
||||
# spec file
|
||||
#
|
||||
# Copyright (c) 2025 SUSE LLC
|
||||
# Copyright (c) 2023 SUSE LLC
|
||||
#
|
||||
# All modifications and additions to the file contributed by third parties
|
||||
# remain the property of their copyright owners, unless otherwise agreed
|
||||
@@ -26,12 +26,12 @@
|
||||
%endif
|
||||
%{?sle15_python_module_pythons}
|
||||
Name: python-Sphinx%{psuffix}
|
||||
Version: 8.2.3
|
||||
Version: 7.2.6
|
||||
Release: 0
|
||||
Summary: Python documentation generator
|
||||
License: BSD-2-Clause
|
||||
Group: Development/Languages/Python
|
||||
URL: https://www.sphinx-doc.org
|
||||
URL: http://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,8 +42,10 @@ 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
|
||||
BuildRequires: %{python_module base}
|
||||
BuildRequires: %{python_module flit-core >= 3.11}
|
||||
BuildRequires: %{python_module flit-core}
|
||||
BuildRequires: %{python_module pip}
|
||||
BuildRequires: %{python_module wheel}
|
||||
BuildRequires: fdupes
|
||||
@@ -55,37 +57,37 @@ Requires: python-Babel >= 1.3
|
||||
Requires: python-Jinja2 >= 2.3
|
||||
Requires: python-Pygments >= 2.14
|
||||
Requires: python-alabaster >= 0.7
|
||||
Requires: python-defusedxml >= 0.7.1
|
||||
Requires: python-docutils >= 0.12
|
||||
Requires: python-imagesize
|
||||
Requires: python-packaging
|
||||
Requires: python-requests >= 2.5.0
|
||||
Requires: python-roman-numerals
|
||||
Requires: python-snowballstemmer >= 1.1
|
||||
Requires: python-sphinx_rtd_theme
|
||||
Requires: python-sphinxcontrib-applehelp
|
||||
Requires: python-sphinxcontrib-devhelp
|
||||
Requires: python-sphinxcontrib-htmlhelp >= 2.0.0
|
||||
Requires: python-sphinxcontrib-jsmath
|
||||
Requires: python-sphinxcontrib-qthelp >= 1.0.2
|
||||
Requires: python-sphinxcontrib-serializinghtml >= 1.1.9
|
||||
Requires: python-sphinxcontrib-websupport
|
||||
Requires(post): update-alternatives
|
||||
Requires(postun): update-alternatives
|
||||
Requires(postun):update-alternatives
|
||||
Recommends: python-SQLAlchemy >= 0.9
|
||||
Recommends: python-Sphinx-doc-man
|
||||
Recommends: python-Whoosh >= 2.0
|
||||
Suggests: python-sphinx_rtd_theme
|
||||
BuildArch: noarch
|
||||
%if 0%{?python_version_nodots} < 310
|
||||
Requires: python-importlib-metadata >= 4.4
|
||||
%endif
|
||||
%if %{with test}
|
||||
BuildRequires: %{python_module Cython}
|
||||
BuildRequires: %{python_module Sphinx = %{version}}
|
||||
BuildRequires: %{python_module Sphinx-latex = %{version}}
|
||||
BuildRequires: %{python_module defusedxml >= 0.7.1}
|
||||
BuildRequires: %{python_module filelock}
|
||||
BuildRequires: %{python_module html5lib}
|
||||
BuildRequires: %{python_module pytest}
|
||||
BuildRequires: %{python_module sphinxcontrib-websupport}
|
||||
BuildRequires: %{python_module testsuite}
|
||||
BuildRequires: %{python_module typing-extensions}
|
||||
BuildRequires: ImageMagick
|
||||
BuildRequires: graphviz
|
||||
# For PNG format
|
||||
@@ -209,7 +211,7 @@ Summary: Man files for python-Sphinx
|
||||
Group: Documentation/Man
|
||||
Requires: python3-Sphinx = %{version}
|
||||
Requires(post): update-alternatives
|
||||
Requires(postun): update-alternatives
|
||||
Requires(postun):update-alternatives
|
||||
Supplements: python3-Sphinx
|
||||
Obsoletes: python-Sphinx-doc-man-common <= %{version}
|
||||
|
||||
@@ -234,7 +236,8 @@ This package contains the HTML documentation for Sphinx.
|
||||
%endif
|
||||
|
||||
%prep
|
||||
%autosetup -p1 -n sphinx-%{version}
|
||||
%setup -q -n sphinx-%{version}
|
||||
%autopatch -p1
|
||||
|
||||
%build
|
||||
%pyproject_wheel
|
||||
@@ -313,13 +316,13 @@ export PYTHONPATH=.
|
||||
export LC_ALL="C.utf8"
|
||||
# test_latex_images test downloading a remote image
|
||||
# test_signature_annotations doesn’t work
|
||||
%pytest tests -k 'not (linkcheck or test_latex_images or test_signature_annotations or test_copy_images or test_ext_imgconverter)'
|
||||
%pytest tests -k 'not (linkcheck or test_latex_images or test_signature_annotations or test_copy_images)'
|
||||
%endif
|
||||
|
||||
%if ! %{with test}
|
||||
%files %{python_files} -f %{python_prefix}-sphinx.lang
|
||||
%license LICENSE.rst
|
||||
%doc CHANGES.rst README.rst
|
||||
%license LICENSE
|
||||
%doc AUTHORS CHANGES README.rst
|
||||
%python_alternative %{_bindir}/sphinx-apidoc
|
||||
%python_alternative %{_bindir}/sphinx-autogen
|
||||
%python_alternative %{_bindir}/sphinx-build
|
||||
@@ -331,21 +334,24 @@ export LC_ALL="C.utf8"
|
||||
%dir %{python_sitelib}/sphinxcontrib
|
||||
|
||||
%files %{python_files latex}
|
||||
%license LICENSE.rst
|
||||
%license LICENSE
|
||||
%doc AUTHORS
|
||||
%{python_sitelib}/sphinx/texinputs/
|
||||
%endif
|
||||
|
||||
%if %{with test}
|
||||
%if 0%{?suse_version} > 1500
|
||||
%files -n python-Sphinx-doc-man
|
||||
%license LICENSE.rst
|
||||
%license LICENSE
|
||||
%doc AUTHORS
|
||||
%{_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.rst
|
||||
%license LICENSE
|
||||
%doc AUTHORS
|
||||
%dir %{_docdir}/python-Sphinx/
|
||||
%{_docdir}/python-Sphinx/html/
|
||||
%endif
|
||||
|
BIN
python3.inv
BIN
python3.inv
Binary file not shown.
BIN
readthedocs.inv
BIN
readthedocs.inv
Binary file not shown.
BIN
requests.inv
BIN
requests.inv
Binary file not shown.
BIN
sphinx-7.2.6.tar.gz
(Stored with Git LFS)
Normal file
BIN
sphinx-7.2.6.tar.gz
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
sphinx-8.2.3.tar.gz
(Stored with Git LFS)
BIN
sphinx-8.2.3.tar.gz
(Stored with Git LFS)
Binary file not shown.
Reference in New Issue
Block a user