1
0
forked from pool/python-Sphinx

13 Commits

Author SHA256 Message Date
79eb6c9c0e Accepting request 1254023 from devel:languages:python
- 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
2025-03-21 19:21:25 +00:00
6fe593e242 include locale again
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=282
2025-03-18 08:05:16 +00:00
e8616955d9 - 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/package/show/devel:languages:python/python-Sphinx?expand=0&rev=281
2025-03-15 11:04:35 +00:00
7b6089fb15 - Add missing dependency python-roman-numerals
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=280
2025-03-12 14:10:49 +00:00
6c626c0c52 OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=279 2025-03-11 12:34:42 +00:00
59e5ac5644 - 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.

OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=278
2025-03-11 12:21:11 +00:00
8392b40d98 Accepting request 1238996 from devel:languages:python
- 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
2025-01-23 16:57:05 +00:00
c58cb08239 re-add dependency defusedxml
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=276
2025-01-20 11:12:56 +00:00
010541a9fc - Add pygments.patch to fix tests with Pygments 2.19
OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=275
2025-01-20 01:16:53 +00:00
ddc596167a OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=274 2024-11-21 09:00:53 +00:00
d475bb0b97 - 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

OBS-URL: https://build.opensuse.org/package/show/devel:languages:python/python-Sphinx?expand=0&rev=273
2024-11-20 17:51:33 +00:00
44ff6878a5 Accepting request 1198296 from devel:languages:python
OBS-URL: https://build.opensuse.org/request/show/1198296
OBS-URL: https://build.opensuse.org/package/show/openSUSE:Factory/python-Sphinx?expand=0&rev=108
2024-09-18 13:26:04 +00:00
42eddaa9a1 Accepting request 1198168 from home:mathletic:branches:devel:languages:python
- 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
2024-09-02 12:31:18 +00:00
7 changed files with 378 additions and 17 deletions

View File

@@ -1,3 +1,368 @@
-------------------------------------------------------------------
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 (20082010) 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>

View File

@@ -1,7 +1,7 @@
#
# spec file for package python-Sphinx
#
# Copyright (c) 2024 SUSE LLC
# Copyright (c) 2025 SUSE LLC
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
@@ -26,7 +26,7 @@
%endif
%{?sle15_python_module_pythons}
Name: python-Sphinx%{psuffix}
Version: 7.4.5
Version: 8.2.3
Release: 0
Summary: Python documentation generator
License: BSD-2-Clause
@@ -43,7 +43,7 @@ Source4: readthedocs.inv
Source5: update-intersphinx.sh
Source99: python-Sphinx.keyring
BuildRequires: %{python_module base}
BuildRequires: %{python_module flit-core}
BuildRequires: %{python_module flit-core >= 3.11}
BuildRequires: %{python_module pip}
BuildRequires: %{python_module wheel}
BuildRequires: fdupes
@@ -60,24 +60,21 @@ 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
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}}
@@ -237,8 +234,7 @@ This package contains the HTML documentation for Sphinx.
%endif
%prep
%setup -q -n sphinx-%{version}
%autopatch -p1
%autosetup -p1 -n sphinx-%{version}
%build
%pyproject_wheel

View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:47e85ad1d3fc4c379ec26262ad14d475df7d29c47eeb6d9fd350a2e52ef08ed2
size 133169
oid sha256:598ad1ec233664ebd19d2e703bedb6832c0bc2cf47ae07b6d5c44dc814d02bda
size 138527

View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:59eb0c9a25e3facf8b32c303e139fd920133b666259bc633bbb86139d3bbccf0
size 25610
oid sha256:3508dae5ee03891797df9df88cbc9c580f0a543eac4f90e1948943fec0dbab17
size 26715

Binary file not shown.

View File

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

BIN
sphinx-8.2.3.tar.gz (Stored with Git LFS) Normal file

Binary file not shown.