mcaulifn / solcast

Apache License 2.0
7 stars 2 forks source link

chore(deps): update dependency sphinx to v7.4.4 #289

Closed renovate[bot] closed 1 month ago

renovate[bot] commented 1 month ago

Mend Renovate

This PR contains the following updates:

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

Release Notes

sphinx-doc/sphinx (Sphinx) ### [`v7.4.4`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-744-released-Jul-15-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.4.3...v7.4.4) \===================================== ## Bugs fixed - [#​12585](https://togithub.com/sphinx-doc/sphinx/issues/12585), [#​12586](https://togithub.com/sphinx-doc/sphinx/issues/12586): Do not warn when an intersphinx inventory contains case-insensitively ambiguous duplicate items. Patch by James Addison. ### [`v7.4.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-743-released-Jul-15-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.4.2...v7.4.3) \===================================== ## Bugs fixed - [#​12582](https://togithub.com/sphinx-doc/sphinx/issues/12582): Restore support for list-styled :confval:`source_suffix` values with extensions that register parsers. Patch by Adam Turner. ### [`v7.4.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-742-released-Jul-15-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.4.1...v7.4.2) \===================================== ## Bugs fixed - [#​12580](https://togithub.com/sphinx-doc/sphinx/issues/12580), [#​12583](https://togithub.com/sphinx-doc/sphinx/issues/12583): Resolve failures with the C domain on incremental builds with Sphinx 7.3.7 and earlier. Patch by Adam Turner. ### [`v7.4.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-741-in-development) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.4.0...v7.4.1) \============================== ## Dependencies ## Incompatible changes ## Deprecated ## Features added ## Bugs fixed - Fix invalid HTML when a rubric node with invalid `heading-level` is used. Patch by Adam Turner. - [#​12579](https://togithub.com/sphinx-doc/sphinx/issues/12579), [#​12581](https://togithub.com/sphinx-doc/sphinx/issues/12581): Restore support for `typing.ParamSpec` in autodoc. Patch by Adam Turner. ## Testing ### [`v7.4.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-740-released-Jul-15-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.7...v7.4.0) \===================================== ## Dependencies - [#​12555](https://togithub.com/sphinx-doc/sphinx/issues/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' ` 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](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/12325): Flatten `Union[Literal[T], Literal[U], ...]` to `Literal[T, U, ...]` when turning annotations into strings. Patch by Adam Turner. - [#​12319](https://togithub.com/sphinx-doc/sphinx/issues/12319): `sphinx.ext.extlinks`: Add `extlink-{name}` CSS class to links. Patch by Hugo van Kemenade. - [#​12387](https://togithub.com/sphinx-doc/sphinx/issues/12387): Improve CLI progress message, when copying assets. Patch by INADA Nakoi and Bénédikt Tran. - [#​12361](https://togithub.com/sphinx-doc/sphinx/issues/12361): Add :attr:`.BuildEnvironment.parser`. Patch by Chris Sewell. - [#​12358](https://togithub.com/sphinx-doc/sphinx/issues/12358): Add :attr:`.Sphinx.fresh_env_used`. Patch by Chris Sewell. - [#​12329](https://togithub.com/sphinx-doc/sphinx/issues/12329): Add detection of ambiguous `std:label` and `std:term` references during loading and resolution of Intersphinx targets. Patch by James Addison. - [#​12422](https://togithub.com/sphinx-doc/sphinx/issues/12422): Do not duplicate "navigation" in aria-label of built-in themes. Patch by Thomas Weißschuh - [#​12421](https://togithub.com/sphinx-doc/sphinx/issues/12421): Include project name in `logo_alt` of built-in themes. Patch by Thomas Weißschuh - [#​12448](https://togithub.com/sphinx-doc/sphinx/issues/12448): Add :option:`sphinx-apidoc --remove-old` option. Patch by Chris Sewell. - [#​12456](https://togithub.com/sphinx-doc/sphinx/issues/12456): Add :option:`sphinx-autogen --remove-old` option. Patch by Chris Sewell. - [#​12479](https://togithub.com/sphinx-doc/sphinx/issues/12479): Add warning subtype `toc.no_title`. Patch by Ondřej Navrátil. - [#​12492](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/12258): Support `typing_extensions.Unpack` Patch by Bénédikt Tran and Adam Turner. - [#​12524](https://togithub.com/sphinx-doc/sphinx/issues/12524): Add a `class` option to the :rst:dir:`toctree` directive. Patch by Tim Hoffmann. - [#​12536](https://togithub.com/sphinx-doc/sphinx/issues/12536): Add the :rst:dir:`confval` directive. Patch by Adam Turner. - [#​12537](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/12523): Added configuration option, :confval:`math_numsep`, to define the separator for math numbering. Patch by Thomas Fanning - [#​11592](https://togithub.com/sphinx-doc/sphinx/issues/11592): Add :confval:`coverage_modules` to the coverage builder to allow explicitly specifying which modules should be documented. Patch by Stephen Finucane. - [#​7896](https://togithub.com/sphinx-doc/sphinx/issues/7896), [#​11989](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/12549): Add optional `description` argument to :meth:`.Sphinx.add_config_value`. Patch by Chris Sewell. - [#​6792](https://togithub.com/sphinx-doc/sphinx/issues/6792): Prohibit module import cycles in :mod:`sphinx.ext.autosummary`. Patch by Trevor Bekolay. - [#​12508](https://togithub.com/sphinx-doc/sphinx/issues/12508): LaTeX: Revamped styling of all admonitions, with addition of a title row with icon. Patch by Jean-François B. - [#​11773](https://togithub.com/sphinx-doc/sphinx/issues/11773): Display :py:class:`~typing.Annotated` annotations with their metadata in the Python domain. Patch by Adam Turner and David Stansby. - [#​12506](https://togithub.com/sphinx-doc/sphinx/issues/12506): Add `level` option to :rst:dir:`rubric` directive. Patch by Chris Sewell. - [#​12567](https://togithub.com/sphinx-doc/sphinx/issues/12567): Add the :event:`write-started` event. Patch by Chris Sewell. ## Bugs fixed - [#​12314](https://togithub.com/sphinx-doc/sphinx/issues/12314): Properly format `collections.abc.Callable` in annotations. Patch by Adam Turner. - [#​12162](https://togithub.com/sphinx-doc/sphinx/issues/12162): Fix a performance regression in the C domain that has been present since version 3.0.0. Patch by Donald Hunter. - [#​12320](https://togithub.com/sphinx-doc/sphinx/issues/12320): Fix removal of anchors from search summaries (regression in 7.3.0). Patch by Will Lachance. - [#​12251](https://togithub.com/sphinx-doc/sphinx/issues/12251): Fix `merge_domaindata()` in `sphinx.ext.duration`. Patch by Matthias Geier. - [#​12224](https://togithub.com/sphinx-doc/sphinx/issues/12224): Properly detect WebP files. Patch by Benjamin Cabé. - [#​12380](https://togithub.com/sphinx-doc/sphinx/issues/12380): LaTeX: Footnote mark sometimes indicates `Page N` where `N` is the current page number and the footnote does appear on that same page. Patch by Jean-François B. - [#​12410](https://togithub.com/sphinx-doc/sphinx/issues/12410): LaTeX: for French and `'lualatex'` as :confval:`latex_engine` `polyglossia` and not `babel` is used (contrarily to `'xelatex'`). Patch by Jean-François B. - [#​12416](https://togithub.com/sphinx-doc/sphinx/issues/12416): Ensure that configuration setting aliases are always synchronised when one value or the other is modified. Patch by Bénédikt Tran. - [#​12220](https://togithub.com/sphinx-doc/sphinx/issues/12220): Fix loading custom template translations for `en` locale. Patch by Nicolas Peugnet. - [#​12459](https://togithub.com/sphinx-doc/sphinx/issues/12459): Add valid-type arguments to the `linkcheck_rate_limit_timeout` configuration setting. Patch by James Addison. - [#​12331](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/12494): Fix invalid genindex.html file produced with translated docs (regression in 7.1.0). Patch by Nicolas Peugnet. - [#​11961](https://togithub.com/sphinx-doc/sphinx/issues/11961): Omit anchor references from document title entries in the search index, removing duplication of search results. Patch by James Addison. - [#​12425](https://togithub.com/sphinx-doc/sphinx/issues/12425): Use Docutils' SVG processing in the HTML builder and remove Sphinx's custom logic. Patch by Tunç Başar Köse. - [#​12391](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/9634): Do not add a fallback language by stripping the country code. Patch by Alvin Wong. - [#​12352](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/11041): linkcheck: Ignore URLs that respond with non-Unicode content. Patch by James Addison. - [#​12543](https://togithub.com/sphinx-doc/sphinx/issues/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.

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.



This PR has been generated by Mend Renovate. View repository job log here.

github-actions[bot] commented 1 month ago

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails
pip/sphinx 7.4.4 :green_circle: 6.1
Details
CheckScoreReason
Code-Review:green_circle: 5Found 16/30 approved changesets -- score normalized to 5
Maintained:green_circle: 1030 commit(s) and 13 issue activity found in the last 90 days -- score normalized to 10
CII-Best-Practices:warning: 0no effort to earn an OpenSSF best practices badge detected
License:green_circle: 9license file detected
Branch-Protection:warning: -1internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration
Signed-Releases:warning: -1no releases found
Dangerous-Workflow:green_circle: 10no dangerous workflow patterns detected
Packaging:warning: -1packaging workflow not detected
Token-Permissions:green_circle: 10GitHub workflow tokens follow principle of least privilege
SAST:warning: 0SAST tool is not run on all commits -- score normalized to 0
Security-Policy:warning: 0security policy file not detected
Binary-Artifacts:green_circle: 10no binaries found in the repo
Pinned-Dependencies:warning: 0dependency not pinned by hash detected -- score normalized to 0
Fuzzing:warning: 0project is not fuzzed
Vulnerabilities:green_circle: 82 existing vulnerabilities detected

Scanned Manifest Files

poetry.lock
  • sphinx@7.4.4
  • sphinx@7.3.7
codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (81657bd) to head (039acc1). Report is 130 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/mcaulifn/solcast/pull/289/graphs/tree.svg?width=650&height=150&src=pr&token=04NTIH61T2&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe)](https://app.codecov.io/gh/mcaulifn/solcast/pull/289?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe) ```diff @@ Coverage Diff @@ ## main #289 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 7 7 Lines 126 126 ========================================= Hits 126 126 ``` | [Flag](https://app.codecov.io/gh/mcaulifn/solcast/pull/289/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/mcaulifn/solcast/pull/289/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe) | `100.00% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe#carryforward-flags-in-the-pull-request-comment) to find out more. ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/mcaulifn/solcast/pull/289?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/mcaulifn/solcast/pull/289?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe). Last update [d650110...039acc1](https://app.codecov.io/gh/mcaulifn/solcast/pull/289?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nathaniel+McAuliffe).
codeclimate[bot] commented 1 month ago

Code Climate has analyzed commit 039acc1d and detected 0 issues on this pull request.

View more on Code Climate.