- 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.
- Add missing dependency python-roman-numerals
- 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)
OBS-URL: https://build.opensuse.org/request/show/1254023
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=110
- 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.
OBS-URL: https://build.opensuse.org/request/show/1253092
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=281
* #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.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=278
- Add pygments.patch to fix tests with Pygments 2.19
- 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.
OBS-URL: https://build.opensuse.org/request/show/1238996
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=109
* #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
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=273
- 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.
OBS-URL: https://build.opensuse.org/request/show/1198168
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=271
- 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
OBS-URL: https://build.opensuse.org/request/show/1188421
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=107
* #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
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=268
- 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.
OBS-URL: https://build.opensuse.org/request/show/1184035
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=106
* #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
- update to 7.2.6:
* #11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES`
environment variable, which if set reloads modules when
using autodoc with ``TYPE_CHECKING = True``.
* #11679: Use :py:func:`importlib.reload` to reload modules in
autodoc.
* autodoc: Support positional-only parameters in classmethod methods
* Restore support string methods on path objects. This is deprecated
and will be removed in Sphinx 8. Use os.fspath() to convert Path
* linkcheck: Resolve hanging tests for timezones west of London and
* Add the :no-typesetting: option to suppress textual output and only
* Restored the the str interface of the asset classes (_CascadingStyleSheet
and _JavaScript), which several extensions relied upon. This will be
variables/structure members
* html: HTML logo or Favicon specified as file not being found on output
* #8959: using UNIX path separator in image directive confuses Sphinx on Windows
bracketed, not braced (and is anyhow not needed)
- Add sphinx-pr8520-fix-AliasNode-copy.patch to fix failing
- add sphinx-pygments-compat.patch (fix tests with newer pygments)
module has submodules
- Recommends only on SUSE
- Move sphinxcontrib namespace into seperate package to avoid
- Split latex-related stuff into its own subpackage so we can
- Be explicit about six version requirements
anymore. If you want to keep italic style, adapt your stylesheet.
figure numbers instead # symbol.
unused_docs have been removed.
font. Custom writers will have to be adapted to handle this node.
lineno-match option. Thanks to Jeppe Pihl.
OBS-URL: https://build.opensuse.org/request/show/1111065
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=101
* #11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES`
environment variable, which if set reloads modules when
using autodoc with ``TYPE_CHECKING = True``.
* #11679: Use :py:func:`importlib.reload` to reload modules in
autodoc.
* autodoc: Support positional-only parameters in classmethod methods
* Restore support string methods on path objects. This is deprecated
and will be removed in Sphinx 8. Use os.fspath() to convert Path
* linkcheck: Resolve hanging tests for timezones west of London and
* Add the :no-typesetting: option to suppress textual output and only
* Restored the the str interface of the asset classes (_CascadingStyleSheet
and _JavaScript), which several extensions relied upon. This will be
variables/structure members
* html: HTML logo or Favicon specified as file not being found on output
* #8959: using UNIX path separator in image directive confuses Sphinx on Windows
bracketed, not braced (and is anyhow not needed)
- Add sphinx-pr8520-fix-AliasNode-copy.patch to fix failing
- add sphinx-pygments-compat.patch (fix tests with newer pygments)
module has submodules
- Recommends only on SUSE
- Move sphinxcontrib namespace into seperate package to avoid
- Split latex-related stuff into its own subpackage so we can
- Be explicit about six version requirements
anymore. If you want to keep italic style, adapt your stylesheet.
figure numbers instead # symbol.
unused_docs have been removed.
font. Custom writers will have to be adapted to handle this node.
lineno-match option. Thanks to Jeppe Pihl.
- Add sphinx-setup_command_unicode.patch: Backport of
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=253
- update to 7.2.5:
* #11645: Fix a regression preventing autodoc from importing
modules within packages that make use of
``if typing.TYPE_CHECKING:`` to guard circular imports
needed by type checkers.
* #11634: Fixed inheritance diagram relative link resolution
for sibling files in a subdirectory.
* #11659: Allow ``?config=...`` in :confval:`mathjax_path`.
* #11654: autodoc: Fail with a more descriptive error message
when an object claims to be an instance of ``type``,
but is not a class.
* 11620: Cease emitting :event:`source-read` events for files
read via the :dudir:`include` directive.
* 11620: Add a new :event:`include-read` for observing and
transforming the content of included files via the :dudir:`include`
directive.
* #11627: Restore support for copyright lines of the form
``YYYY`` when ``SOURCE_DATE_EPOCH`` is set.
OBS-URL: https://build.opensuse.org/request/show/1109692
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=100
* #11645: Fix a regression preventing autodoc from importing
modules within packages that make use of
``if typing.TYPE_CHECKING:`` to guard circular imports
needed by type checkers.
* #11634: Fixed inheritance diagram relative link resolution
for sibling files in a subdirectory.
* #11659: Allow ``?config=...`` in :confval:`mathjax_path`.
* #11654: autodoc: Fail with a more descriptive error message
when an object claims to be an instance of ``type``,
but is not a class.
* 11620: Cease emitting :event:`source-read` events for files
read via the :dudir:`include` directive.
* 11620: Add a new :event:`include-read` for observing and
transforming the content of included files via the :dudir:`include`
directive.
* #11627: Restore support for copyright lines of the form
``YYYY`` when ``SOURCE_DATE_EPOCH`` is set.
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=251
- update to 7.2.4
* Require sphinxcontrib-serializinghtml 1.1.9.
* Fix regression in autodoc.Documenter.parse_name().
* Fix regression in JSON serialisation.
* autodoc: Support positional-only parameters in classmethod methods
when autodoc_preserve_defaults is True.
* Restore support string methods on path objects. This is deprecated
and will be removed in Sphinx 8. Use os.fspath() to convert Path
objects to strings, or Path’s methods to work with path objects.
* Fix a regression in the MoveModuleTargets transform.
* linkcheck: Resolve hanging tests for timezones west of London and
incorrect conversion from UTC to offsets from the UNIX epoch.
- update to 7.2.2
* Drop Python 3.8 support.
* Require Pygments 2.14 or later.
* Deprecate sphinx.util.md5 and sphinx.util.sha1. Use hashlib instead.
* Deprecate sphinx.testing.path. Use os.path or pathlib instead.
* Support os.PathLike types and pathlib.Path objects in many more places.
* Add the :no-typesetting: option to suppress textual output and only
create a linkable anchor.
* Allow running Sphinx with python -m sphinx build
* graphviz: Fix relative links from within the graph.
* pytest: Fail tests on “XPASS”, Set PYTHONWARNINGS=error, set strict config
* Restored the the str interface of the asset classes (_CascadingStyleSheet
and _JavaScript), which several extensions relied upon. This will be
removed in Sphinx 9.
* Many more changes (even deprecations), see upstream changelog
- update to 7.1.2:
* #11542: linkcheck: Properly respect :confval:`linkcheck_anchors`
and do not spuriously report failures to validate anchors.
- Update to 7.1.1:
* #11514: Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer.
Patch by Bénédikt Tran.
- Update to 7.1.0:
* Releases are no longer signed, given the `change in PyPI policy`_.
* #11412: Emit warnings on using a deprecated Python-specific index entry type
(namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``,
``statement``, and ``builtin``) in the :rst:dir:`index` directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.
* #11415: Add a checksum to JavaScript and CSS asset URIs included within
generated HTML, using the CRC32 algorithm.
* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version
requirement to be specified as ``(major, minor)``.
* #11011: Allow configuring a line-length limit for object signatures, via
:confval:`maximum_signature_line_length` and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:`py:function:single-line-parameter-list`.
Patch by Thomas Louf, Adam Turner, and Jean-François B.
* #10983: Support for multiline copyright statements in the footer block.
Patch by Stefanie Molin
* ``sphinx.util.display.status_iterator`` now clears the current line
with ANSI control codes, rather than overprinting with space characters.
* #11431: linkcheck: Treat SSL failures as broken links.
Patch by Bénédikt Tran
* #11157: Keep the ``translated`` attribute on translated nodes.
* #11451: Improve the traceback displayed when using :option:`sphinx-build -T`
in parallel builds. Patch by Bénédikt Tran
* #11324: linkcheck: Use session-basd HTTP requests.
* #11438: Add support for the :rst:dir:`py:class` and :rst:dir:`py:function`
directives for PEP 695 (generic classes and functions declarations) and
PEP 696 (default type parameters). Multi-line support (#11011) is enabled
for type parameters list and can be locally controlled on object description
directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`.
Patch by Bénédikt Tran.
* #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis
via :confval:`linkcheck_anchors_ignore_for_url` while
still checking the validity of the page itself.
Patch by Bénédikt Tran
* #1246: Add translation progress statistics and inspection support,
via a new substitution (``|translation progress|``) and a new
configuration variable (:confval:`translation_progress_classes`).
These enable determining the percentage of translated elements within
a document, and the remaining translated and untranslated elements.
* Restored the ``footnote-reference`` class that has been removed in
the latest (unreleased) version of Docutils.
* #11486: Use :rfc:`8081` font file MIME types in the EPUB builder.
Using the correct MIME type will prevent warnings from ``epubcheck``
and will generate a valid EPUB.
* #11435: Use microsecond-resolution timestamps for outdated file detection
in ``BuildEnvironment.get_outdated_files``.
* #11437: Top-level headings starting with a reStructuredText role
now render properly when :confval:`rst_prolog` is set.
Previously, a file starting with the below would have
improperly rendered due to where the prologue text
was inserted into the document.
Patch by Bénédikt Tran.
* #11337: Fix a ``MemoryError`` in ``sphinx.ext.intersphinx`` when using ``None``
or ``typing.*`` as inline type references. Patch by Bénédikt Tran (picnixz)
* #11345: Always delete ``docutils.conf`` in test directories when running
``SphinxTestApp.cleanup()``.
OBS-URL: https://build.opensuse.org/request/show/1108105
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=99
- update to 7.2.4
* Require sphinxcontrib-serializinghtml 1.1.9.
* Fix regression in autodoc.Documenter.parse_name().
* Fix regression in JSON serialisation.
* autodoc: Support positional-only parameters in classmethod methods
when autodoc_preserve_defaults is True.
* Restore support string methods on path objects. This is deprecated
and will be removed in Sphinx 8. Use os.fspath() to convert Path
objects to strings, or Path’s methods to work with path objects.
* Fix a regression in the MoveModuleTargets transform.
* linkcheck: Resolve hanging tests for timezones west of London and
incorrect conversion from UTC to offsets from the UNIX epoch.
OBS-URL: https://build.opensuse.org/request/show/1108097
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=248
- update to 7.2.2
* Drop Python 3.8 support.
* Require Pygments 2.14 or later.
* Deprecate sphinx.util.md5 and sphinx.util.sha1. Use hashlib instead.
* Deprecate sphinx.testing.path. Use os.path or pathlib instead.
* Support os.PathLike types and pathlib.Path objects in many more places.
* Add the :no-typesetting: option to suppress textual output and only
create a linkable anchor.
* Allow running Sphinx with python -m sphinx build
* graphviz: Fix relative links from within the graph.
* pytest: Fail tests on “XPASS”, Set PYTHONWARNINGS=error, set strict config
* Restored the the str interface of the asset classes (_CascadingStyleSheet
and _JavaScript), which several extensions relied upon. This will be
removed in Sphinx 9.
* Many more changes (even deprecations), see upstream changelog
OBS-URL: https://build.opensuse.org/request/show/1105478
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=247
- Update to 7.1.1:
* #11514: Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer.
Patch by Bénédikt Tran.
- Update to 7.1.0:
* Releases are no longer signed, given the `change in PyPI policy`_.
* #11412: Emit warnings on using a deprecated Python-specific index entry type
(namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``,
``statement``, and ``builtin``) in the :rst:dir:`index` directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.
* #11415: Add a checksum to JavaScript and CSS asset URIs included within
generated HTML, using the CRC32 algorithm.
* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version
requirement to be specified as ``(major, minor)``.
* #11011: Allow configuring a line-length limit for object signatures, via
:confval:`maximum_signature_line_length` and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:`py:function:single-line-parameter-list`.
Patch by Thomas Louf, Adam Turner, and Jean-François B.
* #10983: Support for multiline copyright statements in the footer block.
Patch by Stefanie Molin
* ``sphinx.util.display.status_iterator`` now clears the current line
with ANSI control codes, rather than overprinting with space characters.
* #11431: linkcheck: Treat SSL failures as broken links.
Patch by Bénédikt Tran
* #11157: Keep the ``translated`` attribute on translated nodes.
* #11451: Improve the traceback displayed when using :option:`sphinx-build -T`
in parallel builds. Patch by Bénédikt Tran
* #11324: linkcheck: Use session-basd HTTP requests.
OBS-URL: https://build.opensuse.org/request/show/1101202
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=245
