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 sphinx to 8.0.2 #1045

Merged
merged 2 commits into from
Aug 9, 2024
Merged

Update sphinx to 8.0.2 #1045

merged 2 commits into from
Aug 9, 2024

Conversation

pyup-bot
Copy link
Collaborator

@pyup-bot pyup-bot commented Aug 9, 2024

This PR updates sphinx from 7.4.7 to 8.0.2.

Changelog

8.0.2

=====================================

Bugs fixed
----------

* Fix the ``pygments.Formatter.__class_getitem__`` patch.
Patch by Adam Turner.

8.0.1

=====================================

Bugs fixed
----------

* Patch ``pygments.Formatter.__class_getitem__`` in Pygments 2.17.
Patch by Adam Turner.

8.0.0

=====================================

Dependencies
------------

* 12633: Drop Python 3.9 support.

Incompatible changes
--------------------

.. rst-class:: compact

* 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 :py:func:`!sphinx.util.osutil.cd`
(use :py:func:`contextlib.chdir`).
Patch by Adam Turner.
* Removed :py:func:`!sphinx.util.typing.stringify`
(use :py:func:`!sphinx.util.typing.stringify_annotation`).
Patch by Adam Turner.
* 12593: Raise an error for invalid :confval:`html_sidebars` values.
Patch by Adam Turner.
* 12593: Raise an error in :py:func:`!Theme.get_config` for invalid sections.
Patch by Adam Turner.
* 11693: Remove support for old-style :file:`Makefile` and :file:`make.bat`
output in :program:`sphinx-quickstart`.
* 11693: Remove the :option:`!--no-use-make-mode`, :option:`!-M`,
:option:`!--use-make-mode`, and :option:`!-m` options
from :program:`sphinx-quickstart`.
Patch by Adam Turner.
* Removed the tuple interface to :py:class:`!sphinx.ext.autodoc.ObjectMember`.
Patch by Adam Turner.
* 12630: Sphinx 8 makes two changes to the ``linkcheck`` configuration defaults:

* :confval:`linkcheck_allow_unauthorized` is now ``False`` by default.
* :confval:`linkcheck_report_timeouts_as_broken` is now ``False`` by default.

Patch by James Addison.
* 12597: Change the default of :confval:`show_warning_types`
from ``False`` to ``True``.
Patch by Chris Sewell.
* 12083: Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6
:confval:`intersphinx_mapping` format.
Patch by Bénédikt Tran and Adam Turner.
* 12096: Do not overwrite user-supplied files when copying assets
unless forced with ``force=True``.
Patch by Adam Turner.
* 12646: Remove :py:func:`!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 :py:class:`!VersionChange` in
:py:mod:`!sphinx.directives.other`
(Deprecated since Sphinx 2).
Use :py:class:`!sphinx.domains.changeset.VersionChange` directly.
Patch by Adam Turner.

Deprecated
----------

* 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.
* 12650, 12686, 12690: Extend the deprecation for string methods on
:py:class:`~pathlib.Path` objects to Sphinx 9.
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.
Patch by Adam Turner.
Links

@jmuelbert jmuelbert enabled auto-merge (squash) August 9, 2024 10:24
@jmuelbert jmuelbert disabled auto-merge August 9, 2024 10:24
@jmuelbert jmuelbert merged commit 83feb9c into main Aug 9, 2024
11 of 31 checks passed
@jmuelbert jmuelbert deleted the pyup-update-sphinx-7.4.7-to-8.0.2 branch August 9, 2024 10:24
Copy link

github-actions bot commented Aug 9, 2024

Here are some friendly prose warnings from write-good:

In ./docs/index.md
=============
end-before: <!-- github-only -->
                        ^^^^
"only" can weaken meaning on line 3 at column 24


In ./docs/contributing.md
=============
end-before: <!-- github-only -->
                        ^^^^
"only" can weaken meaning on line 3 at column 24


In ./CODE_OF_CONDUCT.md
=============
- Giving and gracefully accepting constructive feedback
             ^^^^^^^^^^
"gracefully" can weaken meaning on line 22 at column 13
-------------
sing on what is best not just for us as individuals, but for the overall
                         ^^^^
"just" can weaken meaning on line 25 at column 31
-------------
individuals, but for the overall
                         ^^^^^^^
"overall" is wordy or unneeded on line 25 at column 71
-------------
t which could reasonably be considered inappropriate in a
                         ^^^^^^^^^^^^^
"be considered" may be passive voice on line 36 at column 39
-------------
nacceptable behavior may be
                         ^^^^^^^^^^^
"be
reported" may be passive voice on line 61 at column 72
-------------
All complaints will be reviewed and investigated promptly and fairly.
                    ^^^^^^^^^^^
"be reviewed" may be passive voice on line 64 at column 20
-------------
eviewed and investigated promptly and fairly.
                         ^^^^^^^^
"promptly" can weaken meaning on line 64 at column 49
-------------
nvestigated promptly and fairly.
                         ^^^^^^
"fairly" is a weasel word and can weaken meaning on line 64 at column 62
-------------
All community leaders are obligated to respect the privacy and security of the
                      ^^^^^^^^^^^^^
"are obligated" may be passive voice on line 66 at column 22
-------------
te. A public apology may be requested.
                         ^^^^^^^^^^^^
"be requested" may be passive voice on line 81 at column 49
-------------
ing the Code of Conduct, is allowed during this period.
                         ^^^^^^^^^^
"is allowed" may be passive voice on line 103 at column 42
-------------
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
                     ^^^^^^^^^^
"is adapted" may be passive voice on line 117 at column 21
-------------
munity Impact Guidelines were inspired by
                         ^^^^^^^^^^^^^
"were inspired" may be passive voice on line 121 at column 28


In ./README.md
=============
Contributions are very welcome.
                  ^^^^
"very" is a weasel word and can weaken meaning on line 44 at column 18
-------------
This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter]
             ^^^^^^^^^^^^^
"was generated" may be passive voice on line 59 at column 13
-------------
<!-- github-only -->
            ^^^^
"only" can weaken meaning on line 67 at column 12


In ./.github/ISSUE_TEMPLATE/feature_request.md
=============
**Additional context**
  ^^^^^^^^^^
"Additional" is wordy or unneeded on line 18 at column 2


In ./.github/ISSUE_TEMPLATE/bug_report.md
=============
**Additional context**
  ^^^^^^^^^^
"Additional" is wordy or unneeded on line 39 at column 2


In ./CONTRIBUTING.md
=============
Unit tests are located in the _tests_ directory,
           ^^^^^^^^^^^
"are located" may be passive voice on line 85 at column 11
-------------
and are written using the [pytest] testing framework.
    ^^^^^^^^^^^
"are written" may be passive voice on line 86 at column 4
-------------
Feel free to submit early, though—we can always iterate on this.
                    ^^^^^
"early" can weaken meaning on line 100 at column 20
-------------
It is recommended to open an issue before starting work on anything.
^^^^^
"It is" is wordy or unneeded on line 108 at column 0
-------------
It is recommended to open an issue before starting work on anything.
   ^^^^^^^^^^^^^^
"is recommended" may be passive voice on line 108 at column 3
-------------
over with the owners and validate your approach.
                         ^^^^^^^^
"validate" is wordy or unneeded on line 109 at column 61
-------------
<!-- github-only -->
            ^^^^
"only" can weaken meaning on line 113 at column 12

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.

2 participants