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.

Sign up for GitHub

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

Jump to bottom

deps: update dependency sphinx to >=7.3.4,<7.4 #383

Merged
merged 1 commit into from
Apr 17, 2024
Merged

deps: update dependency sphinx to >=7.3.4,<7.4 #383

merged 1 commit into from
Apr 17, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Apr 17, 2024 •
edited
Loading

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
sphinx (changelog) >=7.2.2,<7.3 -> >=7.3.4,<7.4 age adoption passing confidence

Release Notes

sphinx-doc/sphinx (sphinx)

v7.3.4: Sphinx 7.3.4

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

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

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

.. _Docutils 0.21: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09

  • #​12012: Use types-docutils instead of docutils-stubs.

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

  • #​11803: autodoc: Use an overriden __repr__() function in an enum,
    if defined. Patch by Shengyu Zhang.

  • #​11892: Improved performance when resolving cross references in the C++ domain.
    Patch by Rouslan Korneychuk.

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

  • #​11715: Apply tls_verify and tls_cacerts config to
    ImageDownloader.
    Patch by Nick Touran.

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

  • #​11917: Fix rendering of annotated inherited members for Python 3.9.
    Patch by Janet Carson.

  • #​11925: Blacklist the sphinxprettysearchresults extension; the functionality
    it provides was merged into Sphinx v2.0.0.
    Patch by James Addison.

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

  • #​12008: Fix case-sensitive lookup of std:label names in intersphinx inventory.
    Patch by Michael Goerz.

  • #​11959: Fix multiple term matching when word appears in both title and document.
    Patch by Will Lachance.

  • #​11958: HTML Search: Fix partial matches overwriting full matches.
    Patch by William Lachance.

  • #​11944: Use anchor in search preview.
    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 mkay.

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

  • #​12271: Partially revert Docutils' r9562__ to fix EPUB files.
    Patch by Adam Turner.

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

Testing

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

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.

@codecov Codecov
Copy link

codecov bot commented Apr 17, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.85%. Comparing base (0941fbf) to head (2658b4d).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #383   +/-   ##
=======================================
  Coverage   92.85%   92.85%           
=======================================
  Files          65       65           
  Lines        2883     2883           
=======================================
  Hits         2677     2677           
  Misses        206      206

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@renovate renovate bot changed the title deps: update dependency sphinx to >=7.3.2,<7.4 deps: update dependency sphinx to >=7.3.4,<7.4 Apr 17, 2024
@jooola jooola merged commit 69c2e16 into main Apr 17, 2024
10 checks passed
@jooola jooola deleted the renovate/sphinx-7.x branch April 17, 2024 06:36
@hcloud-bot hcloud-bot mentioned this pull request Apr 13, 2024
Merged
jooola pushed a commit that referenced this pull request Jul 3, 2024
@hcloud-bot
chore(main): release 2.0.0 (#380)
cf08842 
🤖 I have created a release *beep* *boop*
---


##
[2.0.0](v1.35.0...v2.0.0)
(2024-07-03)


### ⚠ BREAKING CHANGES

* return full rebuild response in `Client.servers.rebuild`
([#406](#406))
* make `datacenter` argument optional when creating a primary ip
([#363](#363))
* remove deprecated `include_wildcard_architecture` argument in
`IsosClient.get_list` and `IsosClient.get_all`
([#402](#402))
* make `Client.request` `tries` a private argument
([#399](#399))
* make `Client.poll_interval` a private property
([#398](#398))
* return empty dict on empty responses in `Client.request`
([#400](#400))
* remove deprecated `hcloud.hcloud` module
([#401](#401))
* move `hcloud.__version__.VERSION` to `hcloud.__version__`
([#397](#397))

### Features

* add `trace_id` to API exceptions
([#404](#404))
([8375261](8375261))
* allow using a custom poll_interval function
([#403](#403))
([93eb56b](93eb56b))
* make `Client.poll_interval` a private property
([#398](#398))
([d5f24db](d5f24db))
* make `Client.request` `tries` a private argument
([#399](#399))
([428ea7e](428ea7e))
* move `hcloud.__version__.VERSION` to `hcloud.__version__`
([#397](#397))
([4e3f638](4e3f638)),
closes [#234](#234)
* remove deprecated `hcloud.hcloud` module
([#401](#401))
([db37e63](db37e63))
* remove deprecated `include_wildcard_architecture` argument in
`IsosClient.get_list` and `IsosClient.get_all`
([#402](#402))
([6b977e2](6b977e2))
* return empty dict on empty responses in `Client.request`
([#400](#400))
([9f46adb](9f46adb))
* return full rebuild response in `Client.servers.rebuild`
([#406](#406))
([1970d84](1970d84))


### Bug Fixes

* make `datacenter` argument optional when creating a primary ip
([#363](#363))
([ebef774](ebef774))


### Dependencies

* update dependency coverage to &gt;=7.5,&lt;7.6
([#386](#386))
([5660691](5660691))
* update dependency mypy to &gt;=1.10,&lt;1.11
([#387](#387))
([35c933b](35c933b))
* update dependency myst-parser to v3
([#385](#385))
([9f18270](9f18270))
* update dependency pylint to &gt;=3,&lt;3.3
([#391](#391))
([4a6f005](4a6f005))
* update dependency pytest to &gt;=8,&lt;8.3
([#390](#390))
([584a36b](584a36b))
* update dependency sphinx to &gt;=7.3.4,&lt;7.4
([#383](#383))
([69c2e16](69c2e16))
* update pre-commit hook asottile/pyupgrade to v3.16.0
([0ce5fbc](0ce5fbc))
* update pre-commit hook pre-commit/pre-commit-hooks to v4.6.0
([5ef25ab](5ef25ab))
* update pre-commit hook psf/black-pre-commit-mirror to v24.4.0
([0941fbf](0941fbf))
* update pre-commit hook psf/black-pre-commit-mirror to v24.4.1
([fec08c5](fec08c5))
* update pre-commit hook psf/black-pre-commit-mirror to v24.4.2
([#389](#389))
([2b2e21f](2b2e21f))
* update pre-commit hook pycqa/flake8 to v7.1.0
([3bc651d](3bc651d))


### Documentation

* add v2 upgrade notes
([#405](#405))
([c77f771](c77f771))
* cx11 is name, not an id
([#381](#381))
([b745d40](b745d40))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jooola