Skip to content

Commit

Permalink
Bump to 5.0.0 final
Browse files Browse the repository at this point in the history
  • Loading branch information
tk0miya committed May 29, 2022
1 parent 3d3e932 commit 953002e
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 43 deletions.
71 changes: 31 additions & 40 deletions CHANGES
Original file line number Diff line number Diff line change
@@ -1,53 +1,20 @@
Release 5.0.0 beta2 (in development)
====================================
Release 5.0.0 (released May 30, 2022)
=====================================

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

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

* #10474: :confval:`language` does not accept ``None`` as it value. The default
value of ``language`` becomes to ``'en'`` now.

Deprecated
----------

Features added
--------------

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

* #9575: autodoc: The annotation of return value should not be shown when
``autodoc_typehints="description"``
* #9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when
``autodoc_typehints="description"``
* #8180: autodoc: Docstring metadata ignored for attributes
* #10443: epub: EPUB builder can't detect the mimetype of .webp file
* #10104: gettext: Duplicated locations are shown if 3rd party extension does
not provide correct information
* #10456: py domain: ``:meta:`` fields are displayed if docstring contains two
or more meta-field
* #9096: sphinx-build: the value of progress bar for paralle build is wrong
* #10110: sphinx-build: exit code is not changed when error is raised on
builder-finished event
5.0.0 b1

Testing
--------

Release 5.0.0 beta1 (released May 09, 2022)
===========================================

Dependencies
------------
* #10164: Support `Docutils 0.18`_. Patch by Adam Turner.

.. _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26

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

5.0.0 b1

* #10031: autosummary: ``sphinx.ext.autosummary.import_by_name()`` now raises
``ImportExceptionGroup`` instead of ``ImportError`` when it failed to import
target object. Please handle the exception if your extension uses the
Expand All @@ -66,9 +33,16 @@ Incompatible changes
* #10062: Change the default language to ``'en'`` if any language is not set in
``conf.py``

5.0.0 final

* #10474: :confval:`language` does not accept ``None`` as it value. The default
value of ``language`` becomes to ``'en'`` now.

Deprecated
----------

5.0.0 b1

* #10028: jQuery and underscore.js will no longer be automatically injected into
themes from Sphinx 6.0. If you develop a theme or extension that uses the
``jQuery``, ``$``, or ``$u`` global objects, you need to update your
Expand Down Expand Up @@ -101,6 +75,8 @@ Deprecated
Features added
--------------

5.0.0 b1

* #9075: autodoc: The default value of :confval:`autodoc_typehints_format` is
changed to ``'smart'``. It will suppress the leading module names of
typehints (ex. ``io.StringIO`` -> ``StringIO``).
Expand All @@ -125,6 +101,8 @@ Features added
Bugs fixed
----------

5.0.0 b1

* #10200: apidoc: Duplicated submodules are shown for modules having both .pyx
and .so files
* #10279: autodoc: Default values for keyword only arguments in overloaded
Expand Down Expand Up @@ -154,8 +132,21 @@ Bugs fixed
* #10318: ``:prepend:`` option of :rst:dir:`literalinclude` directive does not
work with ``:dedent:`` option

Release 4.5.1 (in development)
==============================
5.0.0 final

* #9575: autodoc: The annotation of return value should not be shown when
``autodoc_typehints="description"``
* #9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when
``autodoc_typehints="description"``
* #8180: autodoc: Docstring metadata ignored for attributes
* #10443: epub: EPUB builder can't detect the mimetype of .webp file
* #10104: gettext: Duplicated locations are shown if 3rd party extension does
not provide correct information
* #10456: py domain: ``:meta:`` fields are displayed if docstring contains two
or more meta-field
* #9096: sphinx-build: the value of progress bar for paralle build is wrong
* #10110: sphinx-build: exit code is not changed when error is raised on
builder-finished event

Release 4.5.0 (released Mar 28, 2022)
=====================================
Expand Down
6 changes: 3 additions & 3 deletions sphinx/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
warnings.filterwarnings('ignore', 'The frontend.Option class .*',
DeprecationWarning, module='docutils.frontend')

__version__ = '5.0.0b1'
__released__ = '5.0.0b1' # used when Sphinx builds its own docs
__version__ = '5.0.0'
__released__ = '5.0.0' # used when Sphinx builds its own docs

#: Version info for better programmatic use.
#:
Expand All @@ -32,7 +32,7 @@
#:
#: .. versionadded:: 1.2
#: Before version 1.2, check the string ``sphinx.__version__``.
version_info = (5, 0, 0, 'beta', 1)
version_info = (5, 0, 0, 'final', 0)

package_dir = path.abspath(path.dirname(__file__))

Expand Down

0 comments on commit 953002e

Please sign in to comment.