Skip to content

Commit

Permalink
Bump to 4.0.0 final
Browse files Browse the repository at this point in the history
  • Loading branch information
tk0miya committed May 9, 2021
1 parent 09bb986 commit a317d00
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 61 deletions.
100 changes: 41 additions & 59 deletions CHANGES
@@ -1,31 +1,16 @@
Release 4.0.0 beta3 (in development)
====================================
Release 4.0.0 (released May 09, 2021)
=====================================

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

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

Deprecated
----------

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

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

* #9167: html: Failed to add CSS files to the specific page
4.0.0b1

Testing
--------
* Drop python 3.5 support
* Drop docutils 0.12 and 0.13 support
* LaTeX: add ``tex-gyre`` font dependency

Release 4.0.0 beta2 (released Apr 29, 2021)
===========================================

Dependencies
------------
4.0.0b2

* Support docutils-0.17. Please notice it changes the output of HTML builder.
Some themes do not support it, and you need to update your custom CSS to
Expand All @@ -34,43 +19,7 @@ Dependencies
Incompatible changes
--------------------

* #9023: Change the CSS classes on :rst:role:`cpp:expr` and
:rst:role:`cpp:texpr`.

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

* #8818: autodoc: Super class having ``Any`` arguments causes nit-picky warning
* #9095: autodoc: TypeError is raised on processing broken metaclass
* #9110: autodoc: metadata of GenericAlias is not rendered as a reference in
py37+
* #9098: html: copy-range protection for doctests doesn't work in Safari
* #9103: LaTeX: imgconverter: conversion runs even if not needed
* #8127: py domain: Ellipsis in info-field-list causes nit-picky warning
* #9121: py domain: duplicated warning is emitted when both canonical and its
alias objects are defined on the document
* #9023: More CSS classes on domain descriptions, see :ref:`nodes` for details.
* #8195: mathjax: Rename :confval:`mathjax_config` to
:confval:`mathjax2_config` and add :confval:`mathjax3_config`

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

* C, C++, fix ``KeyError`` when an ``alias`` directive is the first C/C++
directive in a file with another C/C++ directive later.

Release 4.0.0 beta1 (released Apr 12, 2021)
===========================================

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

* Drop python 3.5 support
* Drop docutils 0.12 and 0.13 support
* LaTeX: add ``tex-gyre`` font dependency

Incompatible changes
--------------------
4.0.0b1

* #8539: autodoc: info-field-list is generated into the class description when
``autodoc_typehints='description'`` and ``autoclass_content='class'`` set
Expand Down Expand Up @@ -107,6 +56,11 @@ Incompatible changes
* #8487: The :file: option for csv-table directive now recognizes an absolute
path as a relative path from source directory

4.0.0b2

* #9023: Change the CSS classes on :rst:role:`cpp:expr` and
:rst:role:`cpp:texpr`.

Deprecated
----------

Expand All @@ -128,6 +82,8 @@ Deprecated
Features added
--------------

4.0.0b1

* #8924: autodoc: Support ``bound`` argument for TypeVar
* #7383: autodoc: Support typehints for properties
* #5603: autodoc: Allow to refer to a python class using its canonical name
Expand Down Expand Up @@ -157,9 +113,26 @@ Features added
* #7199: A new node, ``sphinx.addnodes.pending_xref_condition`` has been added.
It can be used to choose appropriate content of the reference by conditions.

4.0.0b2

* #8818: autodoc: Super class having ``Any`` arguments causes nit-picky warning
* #9095: autodoc: TypeError is raised on processing broken metaclass
* #9110: autodoc: metadata of GenericAlias is not rendered as a reference in
py37+
* #9098: html: copy-range protection for doctests doesn't work in Safari
* #9103: LaTeX: imgconverter: conversion runs even if not needed
* #8127: py domain: Ellipsis in info-field-list causes nit-picky warning
* #9121: py domain: duplicated warning is emitted when both canonical and its
alias objects are defined on the document
* #9023: More CSS classes on domain descriptions, see :ref:`nodes` for details.
* #8195: mathjax: Rename :confval:`mathjax_config` to
:confval:`mathjax2_config` and add :confval:`mathjax3_config`

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

4.0.0b1

* #8917: autodoc: Raises a warning if function has wrong __globals__ value
* #8415: autodoc: a TypeVar imported from other module is not resolved (in
Python 3.7 or above)
Expand Down Expand Up @@ -194,6 +167,15 @@ Bugs fixed
(function) declarators, and in the argument to ``sizeof...``.
* C, fix linking of names in array declarators.

4.0.0b2

* C, C++, fix ``KeyError`` when an ``alias`` directive is the first C/C++
directive in a file with another C/C++ directive later.

4.0.0b3

* #9167: html: Failed to add CSS files to the specific page

Release 3.5.5 (in development)
==============================

Expand Down
4 changes: 2 additions & 2 deletions sphinx/__init__.py
Expand Up @@ -27,7 +27,7 @@
warnings.filterwarnings('ignore', "'U' mode is deprecated",
DeprecationWarning, module='docutils.io')

__version__ = '4.0.0+'
__version__ = '4.0.0'
__released__ = '4.0.0' # used when Sphinx builds its own docs

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

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

Expand Down

0 comments on commit a317d00

Please sign in to comment.