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 ~=7.2.2 #240

Merged
merged 3 commits into from
Sep 13, 2023

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 17, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
sphinx (changelog) ~=7.1.2 -> ~=7.2.2 age adoption passing confidence

Release Notes

sphinx-doc/sphinx (sphinx)

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 "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 requested a review from a team as a code owner August 17, 2023 04:00
@codecov
Copy link

codecov bot commented Aug 17, 2023

Codecov Report

Merging #240 (048c4e3) into master (67d2a8d) will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #240      +/-   ##
==========================================
- Coverage   78.55%   78.52%   -0.03%     
==========================================
  Files          22       22              
  Lines        1907     1909       +2     
==========================================
+ Hits         1498     1499       +1     
- Misses        409      410       +1     

see 2 files with indirect coverage changes

@renovate renovate bot changed the title chore(deps): update dependency sphinx to ~=7.2.0 chore(deps): update dependency sphinx to ~=7.2.1 Aug 17, 2023
@renovate renovate bot force-pushed the renovate/sphinx-7.x branch from 8e4cad2 to 578bed5 Compare August 17, 2023 16:32
@renovate renovate bot changed the title chore(deps): update dependency sphinx to ~=7.2.1 chore(deps): update dependency sphinx to ~=7.2.2 Aug 17, 2023
@renovate renovate bot force-pushed the renovate/sphinx-7.x branch from 578bed5 to 51251b6 Compare August 17, 2023 19:18
@renovate renovate bot force-pushed the renovate/sphinx-7.x branch from 51251b6 to f204a2a Compare August 18, 2023 08:27
@renovate
Copy link
Contributor Author

renovate bot commented Aug 18, 2023

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

Warning: custom changes will be lost.

@cognite-bulldozer cognite-bulldozer bot merged commit 22203c4 into master Sep 13, 2023
5 checks passed
@cognite-bulldozer cognite-bulldozer bot deleted the renovate/sphinx-7.x branch September 13, 2023 06:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant