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

Update dependency Sphinx to v7.2.6 #404

Merged
merged 1 commit into from
Oct 13, 2023

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 12, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
Sphinx (changelog) 7.1.2 -> 7.2.6 age adoption passing confidence

Release Notes

sphinx-doc/sphinx (Sphinx)

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.

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 has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added the dependencies Pull requests that update a dependency file label Oct 12, 2023
@probberechts probberechts merged commit 5649de3 into master Oct 13, 2023
164 of 170 checks passed
@renovate renovate bot deleted the renovate/sphinx-7.x-lockfile branch October 14, 2023 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant