Skip to content

Commit

Permalink
Update dependency sphinx to v8 (#252)
Browse files Browse the repository at this point in the history
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [sphinx](https://github.com/sphinx-doc/sphinx)
([changelog](https://www.sphinx-doc.org/en/master/changes.html)) |
project.optional-dependencies | major | `==7.4.7` -> `==8.0.2` |

---

### Release Notes

<details>
<summary>sphinx-doc/sphinx (sphinx)</summary>

###
[`v8.0.2`](https://github.com/sphinx-doc/sphinx/releases/tag/v8.0.2):
Sphinx 8.0.2

[Compare
Source](https://github.com/sphinx-doc/sphinx/compare/v8.0.1...v8.0.2)

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

###
[`v8.0.1`](https://github.com/sphinx-doc/sphinx/releases/tag/v8.0.1):
Sphinx 8.0.1

[Compare
Source](https://github.com/sphinx-doc/sphinx/compare/v8.0.0...v8.0.1)

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

###
[`v8.0.0`](https://github.com/sphinx-doc/sphinx/releases/tag/v8.0.0):
Sphinx 8.0.0

[Compare
Source](https://github.com/sphinx-doc/sphinx/compare/v7.4.7...v8.0.0)

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

## Dependencies

- [#&#8203;12633](https://github.com/sphinx-doc/sphinx/issues/12633):
Drop Python 3.9 support.

## Incompatible changes

-   Remove deprecated functions from `sphinx.util`:

    -   Removed `sphinx.util.path_stabilize`
        (use `sphinx.util.osutil.path_stabilize`).
    -   Removed `sphinx.util.display_chunk`
        (use `sphinx.util.display.display_chunk`).
    -   Removed `sphinx.util.status_iterator`
        (use `sphinx.util.display.status_iterator`).
    -   Removed `sphinx.util.SkipProgressMessage`
        (use `sphinx.util.display.SkipProgressMessage`).
    -   Removed `sphinx.util.progress_message`
        (use `sphinx.util.display.progress_message`).
    -   Removed `sphinx.util.epoch_to_rfc1123`
        (use `sphinx.http_date.epoch_to_rfc1123`).
    -   Removed `sphinx.util.rfc1123_to_epoch`
        (use `sphinx.http_date.rfc1123_to_epoch`).
    -   Removed `sphinx.util.save_traceback`
        (use `sphinx.exceptions.save_traceback`).
    -   Removed `sphinx.util.format_exception_cut_frames`
        (use `sphinx.exceptions.format_exception_cut_frames`).
    -   Removed `sphinx.util.xmlname_checker`
        (use `sphinx.builders.epub3._XML_NAME_PATTERN`).

    Patch by Adam Turner.
-   Removed `sphinx.util.osutil.cd`
    (use `contextlib.chdir`).
    Patch by Adam Turner.
-   Removed `sphinx.util.typing.stringify`
    (use `sphinx.util.typing.stringify_annotation`).
    Patch by Adam Turner.
- [#&#8203;12593](https://github.com/sphinx-doc/sphinx/issues/12593):
Raise an error for invalid `html_sidebars` values.
    Patch by Adam Turner.
- [#&#8203;12593](https://github.com/sphinx-doc/sphinx/issues/12593):
Raise an error in `Theme.get_config` for invalid sections.
    Patch by Adam Turner.
- [#&#8203;11693](https://github.com/sphinx-doc/sphinx/issues/11693):
Remove support for old-style `Makefile` and `make.bat`
    output in `sphinx-quickstart`.
- [#&#8203;11693](https://github.com/sphinx-doc/sphinx/issues/11693):
Remove the `--no-use-make-mode`, `-M`,
    `--use-make-mode`, and `-m` options
    from `sphinx-quickstart`.
    Patch by Adam Turner.
-   Removed the tuple interface to `sphinx.ext.autodoc.ObjectMember`.
    Patch by Adam Turner.
- [#&#8203;12630](https://github.com/sphinx-doc/sphinx/issues/12630):
Sphinx 8 makes two changes to the `linkcheck` configuration defaults:

    -   `linkcheck_allow_unauthorized` is now `False` by default.
    -   `linkcheck_report_timeouts_as_broken` is now `False` by default.

    Patch by James Addison.
- [#&#8203;12597](https://github.com/sphinx-doc/sphinx/issues/12597):
Change the default of `show_warning_types`
    from `False` to `True`.
    Patch by Chris Sewell.
- [#&#8203;12083](https://github.com/sphinx-doc/sphinx/issues/12083):
Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6
    `intersphinx_mapping` format.
    Patch by Bénédikt Tran and Adam Turner.
- [#&#8203;12096](https://github.com/sphinx-doc/sphinx/issues/12096):
Do not overwrite user-supplied files when copying assets
    unless forced with `force=True`.
    Patch by Adam Turner.
- [#&#8203;12646](https://github.com/sphinx-doc/sphinx/issues/12646):
Remove `sphinx.util.inspect.isNewType`.
Use `isinstance(obj, typing.NewType)` instead on Python 3.10 and newer.
    Patch by Adam Turner.
-   Remove the long-deprecated (since Sphinx 2) alias
    to `VersionChange` in
    `sphinx.directives.other`
    (Deprecated since Sphinx 2).
    Use `sphinx.domains.changeset.VersionChange` directly.
    Patch by Adam Turner.

## Deprecated

- [#&#8203;12643](https://github.com/sphinx-doc/sphinx/issues/12643):
Renamed `sphinx.ext.intersphinx.normalize_intersphinx_mapping`
    to `sphinx.ext.intersphinx.validate_intersphinx_mapping`.
    The old name will be removed in Sphinx 10.
    Patch by Adam Turner.
- [#&#8203;12650](https://github.com/sphinx-doc/sphinx/issues/12650),
[#&#8203;12686](https://github.com/sphinx-doc/sphinx/issues/12686),
[#&#8203;12690](https://github.com/sphinx-doc/sphinx/issues/12690):
Extend the deprecation for string methods on
    `pathlib.Path` objects to Sphinx 9.
Use `os.fspath` to convert :py:class:`~pathlib.Path` objects to strings,
    or `pathlib.Path`'s methods to work with path objects.
    Patch by Adam Turner.

</details>

---

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

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://github.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4xOC4xNyIsInVwZGF0ZWRJblZlciI6IjM4LjIxLjQiLCJ0YXJnZXRCcmFuY2giOiJtYWluIiwibGFiZWxzIjpbXX0=-->
  • Loading branch information
RKIMetadataExchange authored Aug 8, 2024
1 parent 77aa777 commit b80fafa
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
13 changes: 6 additions & 7 deletions pdm.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ optional-dependencies.dev = [
"pytest-xdist==3.6.1",
"pytest==8.3.2",
"ruff==0.5.5",
"sphinx==7.4.7",
"sphinx==8.0.2",
"types-ldap3==2.9.13.20240205",
"types-pytz==2024.1.0.20240417",
"types-requests==2.32.0.20240712",
Expand Down

0 comments on commit b80fafa

Please sign in to comment.