Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update dependency sphinx to v7 - autoclosed #309

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jul 10, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
sphinx (changelog) ~6.2.1 -> ~7.4.0 age adoption passing confidence

Release Notes

sphinx-doc/sphinx (sphinx)

v7.4.7

Compare Source

=====================================

Bugs fixed

  • #​12096: Warn when files are overwritten in the build directory.
    Patch by Adam Turner and Bénédikt Tran.
  • #​12620: Ensure that old-style object description options are respected.
    Patch by Adam Turner.
  • #​12601, #​12625: Support callable objects in :py:class:~typing.Annotated type
    metadata in the Python domain.
    Patch by Adam Turner.
  • #​12601, #​12622: Resolve :py:class:~typing.Annotated warnings with
    sphinx.ext.autodoc,
    especially when using :mod:dataclasses as type metadata.
    Patch by Adam Turner.
  • #​12589, #​12626: autosummary: Fix warnings with :rst:role:!autolink.
    Patch by Adam Turner.

v7.4.6

Compare Source

=====================================

Bugs fixed

  • #​12589, #​9743, #​12609: autosummary: Do not add the package prefix when
    generating autosummary directives for modules within a package.
    Patch by Adam Turner.
  • #​12613: Reduce log severity for ambiguity detection during inventory loading.
    Patch by James Addison.

v7.4.5

Compare Source

=====================================

Bugs fixed

  • #​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.

v7.4.4

Compare Source

=====================================

Bugs fixed

  • #​12585, #​12586: Do not warn when an intersphinx inventory contains
    case-insensitively ambiguous duplicate items.
    Patch by James Addison.

v7.4.3

Compare Source

=====================================

Bugs fixed

  • #​12582: Restore support for list-styled :confval:source_suffix values
    with extensions that register parsers.
    Patch by Adam Turner.

v7.4.2

Compare Source

=====================================

Bugs fixed

  • #​12580, #​12583: Resolve failures with the C domain on incremental builds
    with Sphinx 7.3.7 and earlier.
    Patch by Adam Turner.

v7.4.1

Compare Source

=====================================

Bugs fixed

  • 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.

v7.4.0

Compare Source

=====================================

Dependencies

  • #​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.

Deprecated

  • LaTeX: the sphinxlightbox environment is not used anymore, all types
    of admonitions use (by default) only sphinxheavybox.

Features added

.. rst-class:: compact

  • #​11165: Support the officially recommended_ .jinja suffix for template
    files.
    Patch by James Addison and Adam Turner

    .. _officially recommended: https://jinja.palletsprojects.com/en/latest/templates/#template-file-extension

  • #​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.

  • #​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.

  • #​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.

  • #​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

  • #​12448: Add :option:sphinx-apidoc --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.

  • #​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.

  • #​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.

  • #​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

  • #​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.

  • #​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.

  • #​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.

  • #​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.

Bugs fixed

  • #​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: Avoid footnote markers Page N when N is already
    the current page number.
    Patch by Jean-François B.
  • #​12410: LaTeX: for French and 'lualatex' as :confval:latex_engine
    use babel as with 'xelatex' (and not polyglossia).
    Patch by Jean-François B.
  • #​12520: LaTeX: let :rst:dir:todolist produce correct hyperlinks in PDF.
    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.

Testing

  • karma: refactor HTML search tests to use fixtures generated by Sphinx.
    Patch by James Addison.

v7.3.7

Compare Source

=====================================

Bugs fixed

  • #​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.

v7.3.6

Compare Source

=====================================

Bugs fixed

  • #​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.

v7.3.5

Compare Source

=====================================

Bugs fixed

  • #​12295: Re-export various objects from sphinx.domains.python._object
    in sphinx.domains.python.
    Patch by Jacob Chesslo and Adam Turner.

v7.3.4

Compare Source

=====================================

Bugs fixed

  • Handle cases when Any is not an instance of type.
    Patch by Adam Turner.

v7.3.3

Compare Source

=====================================

Bugs fixed

  • #​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.

v7.3.2

Compare Source

=====================================

Bugs fixed

  • 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.

v7.3.1

Compare Source

=====================================

Dependencies

  • Require tomli on Python 3.10 and earlier.
    Patch by Adam Turner.

v7.3.0

Compare Source

=====================================

Dependencies

Deprecated

  • #​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.

Features added

  • #​12265: Support theme configuration via theme.toml.

  • #​11701: HTML Search: Adopt the new \<search\>_ element.
    Patch by Bénédikt Tran.

    .. _\<search\>: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/search

  • #​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.

    .. _OSC 8: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
    .. _groff: https://lists.gnu.org/archive/html/groff/2021-10/msg00000.html

  • #​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.

Bugs fixed

  • #​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.

    __ https://sourceforge.net/p/docutils/code/9562/

  • #​12253: Escape reserved path characters in the remote images post-transform
    download cache.
    Patch by James Addison and Adam Turner.

Testing

  • 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.

v7.2.6

Compare Source

=====================================

Bugs fixed

  • #​11679: Add the :envvar:!SPHINX_AUTODOC_RELOAD_MODULES environment variable,
    which if set reloads modules when using autodoc with TYPE_CHECKING = True.
    Patch by Matt Wozniski and Adam Turner.
  • #​11679: Use :py:func:importlib.reload to reload modules in autodoc.
    Patch by Matt Wozniski and Adam Turner.

v7.2.5

Compare Source

=====================================

Bugs fixed

  • #​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.
    Patch by Matt Wozniski.
  • #​11634: Fixed inheritance diagram relative link resolution
    for sibling files in a subdirectory.
    Patch by Albert Shih.
  • #​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.
    Patch by James Braza.
  • 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.

v7.2.4

Compare Source

=====================================

Bugs fixed

  • #​11618: Fix a regression in the MoveModuleTargets transform,
    introduced in #​10478 (#​9662).
  • #​11649: linkcheck: Resolve hanging tests for timezones west of London
    and incorrect conversion from UTC to offsets from the UNIX epoch.
    Patch by Dmitry Shachnev and Adam Turner.

v7.2.3

Compare Source

=====================================

Dependencies

  • #​11576: Require sphinxcontrib-serializinghtml 1.1.9.

Bugs fixed

  • Fix regression in autodoc.Documenter.parse_name().
  • Fix regression in JSON serialisation.
  • #​11543: 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 :py:func:os.fspath to convert :py:class:~pathlib.Path objects to strings,
    or :py:class:~pathlib.Path's methods to work with path objects.

v7.2.2

Compare Source

=====================================

Bugs fixed

  • Fix the signature of the StateMachine.insert_input() patch,
    for when calling with keyword arguments.
  • Fixed membership testing (in) for the :py:class:str interface
    of the asset classes (_CascadingStyleSheet and _JavaScript),
    which several extensions relied upon.
  • Fixed a type error in SingleFileHTMLBuilder._get_local_toctree,
    includehidden may be passed as a string or a boolean.
  • Fix :noindex: for PyModule and JSModule.

v7.2.1

Compare Source

=====================================

Bugs fixed

  • Restored the the :py:class:str interface of the asset classes
    (_CascadingStyleSheet and _JavaScript),
    which several extensions relied upon.
    This will be removed in Sphinx 9.
  • Restored calls to Builder.add_{css,js}_file(),
    which several extensions relied upon.
  • Restored the private API TocTree.get_toctree_ancestors(),
    which several extensions relied upon.

v7.2.0

Compare Source

=====================================

Dependencies

Deprecated

  • #​11512: Deprecate sphinx.util.md5 and sphinx.util.sha1.
    Use hashlib instead.
  • #​11526: Deprecate sphinx.testing.path.
    Use os.path or pathlib instead.
  • #​11528: Deprecate sphinx.util.split_index_msg and sphinx.util.split_into.
    Use sphinx.util.index_entries.split_index_msg instead.
  • Deprecate sphinx.builders.html.Stylesheet
    and sphinx.builders.html.Javascript.
    Use sphinx.application.Sphinx.add_css_file()
    and sphinx.application.Sphinx.add_js_file() instead.
  • #​11582: Deprecate sphinx.builders.html.StandaloneHTMLBuilder.css_files and
    sphinx.builders.html.StandaloneHTMLBuilder.script_files.
    Use sphinx.application.Sphinx.add_css_file()
    and sphinx.application.Sphinx.add_js_file() instead.
  • #​11459: Deprecate sphinx.ext.autodoc.preserve_defaults.get_function_def().
    Patch by Bénédikt Tran.

Features added

  • #​11526: Support os.PathLike types and pathlib.Path objects
    in many more places.
  • #​5474: coverage: Print summary statistics tables.
    Patch by Jorge Leitao.
  • #​6319: viewcode: Add :confval:viewcode_line_numbers to control
    whether line numbers are added to rendered source code.
    Patch by Ben Krikler.
  • #​9662: Add the :no-typesetting: option to suppress textual output
    and only create a linkable anchor.
    Patch by Latosha Maltba.
  • #​11221: C++: Support domain objects in the table of contents.
    Patch by Rouslan Korneychuk.
  • #​10938: doctest: Add :confval:doctest_show_successes option.
    Patch by Trey Hunner.
  • #​11533: Add :no-index:, :no-index-entry:, and :no-contents-entry:.
  • #​11572: Improve debug logging of reasons why files are detected as out of
    date.
    Patch by Eric Larson.
  • #​10678: Emit :event:source-read events for files read via
    the :dudir:include directive.
    Patch by Halldor Fannar.
  • #​11570: Use short names when using :pep:585 built-in generics.
    Patch by Riccardo Mori.
  • #​11300: Improve SigElementFallbackTransform fallback logic and signature
    text elements nodes. See :doc:the documentation </extdev/nodes> for more
    details.
    Patch by Bénédikt Tran.
  • Allow running Sphinx with python -m sphinx build ....

Bugs fixed

  • #​11077: graphviz: Fix relative links from within the graph.
    Patch by Ralf Grubenmann.
  • #​11529: Line Block in LaTeX builder outputs spurious empty token.
    Patch by Adrian Vollmer.
  • #​11196: autosummary: Summary line extraction failed with "e.g."
  • #​10614: Fixed a number of bugs in inheritance diagrams that resulted in
    missing or broken links.
    Patch by Albert Shih.
  • #​9428: Exclude substitution definitions when running the gettext builder.
    Patch by Alvin Wong.
  • #​10795: Raise a descriptive error if graphviz_dot is falsy.
  • #​11546: Translated nodes identical to their original text are now marked
    with the translated=True attribute.
  • #​10049: html: Change "Permalink" to "Link" for title text in link anchors.
  • #​4225: Relax Pygments parsing on lexing failures.
  • #​11246: Allow inline links in the first line of a docstring and one-line
    type comments #: :meta ...: when using :mod:sphinx.ext.napoleon.
    Patch by Bénédikt Tran.
  • #​10930: Highlight all search terms on the search results page.
    Patch by Dmitry Shachnev.
  • #​11473: Type annotations containing :py:data:~typing.Literal enumeration
    values now render correctly.
    Patch by Bénédikt Tran.
  • #​11591: Fix support for C coverage in sphinx.ext.coverage extension.
    Patch by Stephen Finucane.
  • #​11594: HTML Theme: Enhancements to horizontal scrolling on smaller
    devices in the agogo theme.
    Patch by Lukas Engelter.
  • #​11459: Fix support for async and lambda functions in
    sphinx.ext.autodoc.preserve_defaults.
    Patch by Bénédikt Tran.

Testing

  • #​11577: pytest: Fail tests on "XPASS".
  • #​11577: pytest: Use "importlib" import mode.
  • #​11577: pytest: Set PYTHONWARNINGS=error.
  • #​11577: pytest: Set strict config and strict markers.

v7.1.2

Compare Source

=====================================

Bugs fixed

  • #​11542: linkcheck: Properly respect :confval:linkcheck_anchors
    and do not spuriously report failures to validate anchors.
    Patch by James Addison.

v7.1.1

Compare Source

=====================================

Bugs fixed

  • #​11514: Fix SOURCE_DATE_EPOCH in multi-line copyright footer.
    Patch by Bénédikt Tran.

v7.1.0

Compare Source

=====================================

Incompatible changes

Deprecated

  • #​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.

Features added

  • #​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 James Addison.
  • #​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.

Bugs fixed

  • 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.

    .. code:: rst

    :mod:lobster -- The lobster module

    ...

    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)

Testing

  • #​11345: Always delete docutils.conf in test directories when running
    SphinxTestApp.cleanup().

v7.0.1

Compare Source

=====================================

Dependencies

  • #​11411: Support Docutils 0.20_. Patch by Adam Turner.

.. _Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04

Bugs fixed

  • #​11418: Clean up remaining references to sphinx.setup_command
    following the removal of support for setuptools.
    Patch by Willem Mulder.

v7.0.0

Compare Source

=====================================

Incompatible changes

  • #​11359: Remove long-deprecated aliases for MecabSplitter and
    DefaultSplitter in sphinx.search.ja.
  • #​11360: Remove deprecated make_old_id functions in domain object
    description classes.
  • #​11363: Remove the Setuptools integration (build_sphinx hook in
    setup.py).
  • #​11364: Remove deprecated sphinx.ext.napoleon.iterators module.
  • #​11365: Remove support for the jsdump format in sphinx.search.
  • #​11366: Make locale a required argument to
    sphinx.util.i18n.format_date().
  • #​11370: Remove deprecated sphinx.util.stemmer module.
  • #​11371: Remove deprecated sphinx.pycode.ast.parse() function.
  • #​11372: Remove deprecated sphinx.io.read_doc() function.
  • #​11373: Removed deprecated sphinx.util.get_matching_files() function.
  • #​11378: Remove deprecated sphinx.util.docutils.is_html5_writer_available()
    function.
  • #​11379: Make the env argument to Builder subclasses required.
  • #​11380: autosummary: Always emit grouped import exceptions.
  • #​11381: Remove deprecated style key for HTML templates.
  • #​11382: Remove deprecated sphinx.writers.latex.LaTeXTranslator.docclasses
    attribute.
  • #​11383: Remove deprecated sphinx.builders.html.html5_ready and
    sphinx.builders.html.HTMLTranslator attributes.
  • #​11385: Remove support for HTML 4 output.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added chore dependencies Pull requests that update a dependency file labels Jul 10, 2023
@renovate
Copy link
Contributor Author

renovate bot commented Jul 10, 2023

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: poetry.lock
Updating dependencies
Resolving dependencies...

Creating virtualenv mutapath-j8m1FZcp-py3.12 in /home/ubuntu/.cache/pypoetry/virtualenvs

The current project's Python requirement (>=3.8,<4.0) is not compatible with some of the required packages Python requirement:
  - sphinx requires Python >=3.9, so it will not be satisfied for Python >=3.8,<3.9
  - sphinx requires Python >=3.9, so it will not be satisfied for Python >=3.8,<3.9
  - sphinx requires Python >=3.9, so it will not be satisfied for Python >=3.8,<3.9
  - sphinx requires Python >=3.9, so it will not be satisfied for Python >=3.8,<3.9
  - sphinx requires Python >=3.9, so it will not be satisfied for Python >=3.8,<3.9

Because no versions of sphinx match >7.3.0,<7.3.1 || >7.3.1,<7.3.2 || >7.3.2,<7.3.3 || >7.3.3,<7.3.4 || >7.3.4,<7.4.0
 and sphinx (7.3.0) requires Python >=3.9, sphinx is forbidden.
And because sphinx (7.3.1) requires Python >=3.9, sphinx is forbidden.
And because sphinx (7.3.2) requires Python >=3.9
 and sphinx (7.3.3) requires Python >=3.9, sphinx is forbidden.
So, because sphinx (7.3.4) requires Python >=3.9
 and mutapath depends on sphinx (~7.3.0), version solving failed.

  • Check your dependencies Python requirement: The Python requirement can be specified via the `python` or `markers` properties
    
    For sphinx, a possible solution would be to set the `python` property to ">=3.9,<4.0"
    For sphinx, a possible solution would be to set the `python` property to ">=3.9,<4.0"
    For sphinx, a possible solution would be to set the `python` property to ">=3.9,<4.0"
    For sphinx, a possible solution would be to set the `python` property to ">=3.9,<4.0"
    For sphinx, a possible solution would be to set the `python` property to ">=3.9,<4.0"

    https://python-poetry.org/docs/dependency-specification/#python-restricted-dependencies,
    https://python-poetry.org/docs/dependency-specification/#using-environment-markers

@matfax matfax added the onhold label Jul 10, 2023
@matfax
Copy link
Owner

matfax commented Jul 10, 2023

This remains on hold until readthedocs/sphinx_rtd_theme#1463 is resolved.

@renovate renovate bot force-pushed the renovate/sphinx-7.x branch from 03407c2 to 9373624 Compare July 10, 2023 15:12
@renovate renovate bot force-pushed the renovate/sphinx-7.x branch from 9373624 to 04ac01e Compare July 24, 2023 20:22
@renovate renovate bot temporarily deployed to google cloud July 24, 2023 20:22 Inactive
@github-actions

This comment has been minimized.

@renovate renovate bot force-pushed the renovate/sphinx-7.x branch from 04ac01e to ab05a57 Compare August 17, 2023 05:09
@renovate renovate bot temporarily deployed to google cloud August 17, 2023 05:09 Inactive
@github-actions

This comment has been minimized.

@renovate renovate bot force-pushed the renovate/sphinx-7.x branch from ab05a57 to e12d734 Compare April 17, 2024 01:40
@renovate renovate bot temporarily deployed to google cloud April 17, 2024 01:40 Inactive

This comment has been minimized.

Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@renovate renovate bot force-pushed the renovate/sphinx-7.x branch from e12d734 to bfb9b8d Compare July 15, 2024 07:26
Copy link
Contributor Author

renovate bot commented Jul 15, 2024

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: poetry.lock
Updating dependencies
Resolving dependencies...

Creating virtualenv mutapath-j8m1FZcp-py3.12 in /home/ubuntu/.cache/pypoetry/virtualenvs

The current project's Python requirement (>=3.8,<4.0) is not compatible with some of the required packages Python requirement:
  - sphinx requires Python >=3.9, so it will not be satisfied for Python >=3.8,<3.9

Because no versions of sphinx match >7.4.0,<7.5.0
 and sphinx (7.4.0) requires Python >=3.9, sphinx is forbidden.
So, because mutapath depends on sphinx (~7.4.0), version solving failed.

  • Check your dependencies Python requirement: The Python requirement can be specified via the `python` or `markers` properties
    
    For sphinx, a possible solution would be to set the `python` property to ">=3.9,<4.0"

    https://python-poetry.org/docs/dependency-specification/#python-restricted-dependencies,
    https://python-poetry.org/docs/dependency-specification/#using-environment-markers

@renovate renovate bot temporarily deployed to google cloud July 15, 2024 07:26 Inactive
Copy link
Contributor

Packj Packj Audit Report

✅ No new dependencies are introduced

Triggered by workflow run 43 on commit 14f0e9ac9f3d8ec6d118d41f2825a3fbaebd64bc

@renovate renovate bot changed the title chore(deps): update dependency sphinx to v7 chore(deps): update dependency sphinx to v7 - autoclosed Jul 29, 2024
@renovate renovate bot closed this Jul 29, 2024
@renovate renovate bot deleted the renovate/sphinx-7.x branch July 29, 2024 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore dependencies Pull requests that update a dependency file onhold
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant