Log Message:
py-sphinx: updated to 4.2.0

Release 4.2.0 (released Sep 12, 2021)
=====================================

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

* autodoc: Support class properties
* autodoc: Emit a warning if target is a mocked object
* autodoc: Allow to refer NewType instances with module name in Python
  3.10 or above
* html theme: Expose the version of Sphinx in the form of tuple as a
  template variable ``sphinx_version_tuple``
* manpage: Suppress the title of man page if description is empty
* py domain: ``:py:property:`` directive supports ``:classmethod:``
  option to describe the class property
* test: SphinxTestApp can take ``builddir`` as an argument
* C and C++, support more fundamental types, including GNU extensions.

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

* apidoc: apidoc does not generate a module definition for implicit
  namespace package
* autodoc: generate incorrect reference to the parent class if the target
  class inherites the class having ``_name`` attribute
* autodoc: Some objects under ``typing`` module are not displayed
  well with the HEAD of 3.10
* autodoc: typehint for cached_property is not shown
* autodoc: AttributeError is raised on failed resolving typehints
* autodoc: autodoc_docstring_signature does not effect to ``__init__()``
  and ``__new__()``
* autodoc: PEP 585 style typehints having arguments (ex. ``list[int]``)
  are not displayed well
* autosummary: some warnings contain non-existing filenames
* autosummary: summarise overlined sectioned headings correctly
* autosummary: Type annotations which contain commas in autosummary table
  are not removed completely
* c domain: some warnings contain non-existing filenames
* cpp domain: some warnings contain non-existing filenames
* html search: abbreation marks are inserted to the search result if
  failed to fetch the content of the page
* html search: The JS requirement warning is shown if browser is slow
* html theme: CSS and JS files added by theme were loaded twice
* py domain: ``:type:`` option for :rst:dir:`py:property` directive does
  not create a hyperlink
* py domain: Literal typehint was converted to a cross reference
* comment: C++, fix parsing of defaulted function parameters that are
  function pointers.
* smartquotes: don't adjust typography for text with
  language-highlighted ``:code:`` role.
* sphinx-build: crashed with the HEAD of Python 3.10

Release 4.1.2 (released Jul 27, 2021)
=====================================

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

* linkcheck: Disable checking automatically generated anchors on
  github.com (ex. anchors in reST/Markdown documents)

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

* autodoc: Custom types using ``typing.NewType`` are not displayed well
  with the HEAD of 3.10
* autodoc: Some objects under ``typing`` module are not displayed well
  with the HEAD of 3.10
* autodoc: crashed if ``autodoc_class_signature = "separated"``
* html search: html_copy_source can't control the search summaries
* linkcheck: Failed to check anchors in github.com

Release 4.1.1 (released Jul 15, 2021)
=====================================

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

* sphinxcontrib-htmlhelp-2.0.0 or above
* sphinxcontrib-serializinghtml-1.1.5 or above

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

* html: HTML logo or Favicon specified as file not being found on output

Release 4.1.0 (released Jul 12, 2021)
=====================================

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

* Support jinja2-3.0

Deprecated
----------

* The ``app`` argument of ``sphinx.environment.BuildEnvironment`` becomes
  required
* ``sphinx.application.Sphinx.html_theme``
* ``sphinx.ext.autosummary._app``
* ``sphinx.util.docstrings.extract_metadata()``

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

* autodoc: Add ``class-doc-from`` option to :rst:dir:`autoclass`
  directive to control the content of the specific class like
  :confval:`autoclass_content`
* autodoc: :confval:`autodoc_type_aliases` now supports dotted name. It
  allows you to define an alias for a class with module name like
  ``foo.bar.BazClass``
* autodoc: Special member is not documented in the module
* autodoc: The arguments of ``typing.Literal`` are wrongly rendered
* autodoc: :confval:`autodoc_typehints` allows ``'both'`` setting to
  allow typehints to be included both in the signature and description
* autodoc: Add :confval:`autodoc_class_signature` to separate the class
  entry and the definition of ``__init__()`` method
* autodoc: Support variable comment for alias classes
* autodoc: Add :event:`autodoc-process-bases` to modify the base classes
  of the class definitions
* autodoc: Render enum values for the default argument value better
* autodoc: ``autodoc_typehints='none'`` now erases typehints for
  variables, attributes and properties
* autosummary: Support instance attributes for classes
* html: Add "heading" role to the toctree items
* html: Add span tag to the return typehint of method/function
* html search: Show search summaries when html_copy_source = False
* html search: Prevent corrections and completions in search field
* html theme: Eliminate prompt characters of code-block from copyable
  text
* i18n: Emit a debug message if message catalog file not found under
  :confval:`locale_dirs`
* LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents
* linkcheck: Support checking anchors on github.com
* linkcheck: Add a new event :event:`linkcheck-process-uri` to modify
  URIs before checking hyperlinks
* linkcheck: Add :confval:`linkcheck_allowed_redirects` to mark
  hyperlinks that are redirected to expected URLs as "working"
* py domain: Support union types using ``|`` in info-field-list
* py domain: :confval:`python_use_unqualified_type_names` supports type
  field in info-field-list
* Optimize the parallel build
* Add :confval:`nitpick_ignore_regex` to ignore nitpicky warnings using
  regular expressions
* Add ``Sphinx.set_html_assets_policy`` to tell extensions to include
  HTML assets in all the pages. Extensions can check this via
  ``Sphinx.registry.html_assets_policy``
* C++, add support for

  - ``inline`` variables,
  - ``consteval`` functions,
  - ``constinit`` variables,
  - ``char8_t``,
  - ``explicit(<constant expression>)`` specifier,
  - digit separators in literals, and
  - constraints in placeholder type specifiers, aka. adjective syntax
    (e.g., ``Sortable auto &v``).

* C, add support for digit separators in literals.
* LaTeX: support containers in LaTeX output

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

* autodoc: stacked singledispatches are wrongly rendered
* autodoc: a docsting having metadata only should be treated as
  undocumented
* autodoc: typehints for overloaded functions and methods are inaccurate
* autodoc: The inherited method not having docstring is wrongly parsed
* autodoc: autoattribute directive failed to generate document for an
  attribute not having any comment
* autodoc: single element tuple on the default argument value is wrongly
  rendered
* autodoc: AttributeError is raised on processing a subclass of Tuple[()]
* autodoc: TypeError is raised on processing dict-like object (not a
  class) via autoclass directive
* html: Pushing left key causes visiting the next page at the first page
* html: URL for html_favicon and html_log does not work
* html theme : pyramid theme generates incorrect logo links
* manpage: The name of manpage directory that is generated by
  :confval:`man_make_section_directory` is not correct
* manpage: Fix font isn't reset after keyword at the top of samp role
* Linkcheck reports broken link when remote server closes the connection
  on HEAD request
* py domain: "exceptions" module is not displayed
* py domain: a Callable annotation with no parameters
  (e.g. ``Callable[[], None])`` will be rendered with a bracket missing
  (``Callable[], None]``)
* quickstart: Make sphinx-quickstart exit when conf.py already exists
* xml: XML Builder ignores custom visitors
* ``:param:`` and ``:type:`` fields does not support a type containing
  whitespace (ex. ``Dict[str, str]``)
* when transforming typed fields, call the specified role instead of
  making an single xref. For C and C++, use the ``expr`` role for typed fields.

Release 4.0.3 (released Jul 05, 2021)
=====================================

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

* C, add C23 keywords ``_Decimal32``, ``_Decimal64``, and ``_Decimal128``.
* C, add :confval:`c_extra_keywords` to allow user-defined keywords
  during parsing.
* Revert the removal of ``sphinx.util:force_decode()`` to become some 3rd party
  extensions available again during 5.0

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

* changeset domain: :rst:dir:`versionchanged` with contents being a list
  will cause error during pdf build
* LaTeX: complex table with merged cells broken since 4.0
* LaTeX: backslash may cause Improper discretionary list pdf build error
  with Japanese engines
* C, remove special macro names from the keyword list.
  See also :confval:`c_extra_keywords`.
* KeyError is raised on PropagateDescDomain transform

Release 4.0.2 (released May 20, 2021)
=====================================

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

* Support jinja2-3.0

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

* Update Underscore.js to 1.13.1
* manpage: Stop creating a section directory on build manpage by default
  (see :confval:`man_make_section_directory`)

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

* viewcode: crashed if non importable modules found on parallel build
* Unknown node error for pending_xref_condition is raised if an extension
  that does not support the node installs a missing-reference handler

Release 4.0.1 (released May 11, 2021)
=====================================

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

* autodoc: crashed when ValueError is raised on generating signature
  from a property of the class
* autosummary: warning is emitted if list value is set to
  autosummary_generate
* html search: tags for search result are broken
* i18n: Babel emits errors when running compile_catalog
* py domain: The :canonical: option causes "more than one target for
  cross-reference" warning
* websupport: UndefinedError is raised: 'css_tag' is undefined

Release 4.0.0 (released May 09, 2021)
=====================================

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

4.0.0b1

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

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
  upgrade it.

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

4.0.0b1

* autodoc: info-field-list is generated into the class description when
  ``autodoc_typehints='description'`` and ``autoclass_content='class'`` set
* extlinks: "%s" becomes required keyword in the link caption string
* domain: The ``Index`` class becomes subclasses of ``abc.ABC`` to indicate
  methods that must be overridden in the concrete classes
* py domain: The structure of python objects is changed.  A boolean value
  is added to indicate that the python object is canonical one
* MathJax: The MathJax was changed from 2 to 3. Users using a custom
  MathJax configuration may have to set the old MathJax path or update their
  configuration for version 3. See :mod:`sphinx.ext.mathjax`.
* i18n: The msgid for alt text of image is changed
* napoleon: :confval:`napoleon_use_param` also affect "other parameters"
  section
* manpage: Make a section directory on build manpage by default (see
  :confval:`man_make_section_directory`)
* html: Change the default setting of
  :confval:`html_codeblock_linenos_style` to ``'inline'``
* html search: search results are wrapped with ``<p>`` instead of
  ``<div>``
* html theme: Move a script tag for documentation_options.js in
  basic/layout.html to ``script_files`` variable
* html theme: Move CSS tags in basic/layout.html to ``css_files`` variable
* html theme: Emit a warning for sphinx_rtd_theme-0.2.4 or older
* LaTeX: uplatex becomes a default setting of latex_engine for Japanese
  documents
* py domain: ``:var:``, ``:cvar:`` and ``:ivar:`` fields do not create
  cross-references
* The ``align`` attribute of ``figure`` and ``table`` nodes becomes
  ``None`` by default instead of ``'default'``
* LaTeX refactoring: split sphinx.sty into multiple files and rename
  some auxiliary files created in ``latex`` build output repertory
* Use explicit title instead of <no title>
* The :file: option for csv-table directive now recognizes an absolute
  path as a relative path from source directory

4.0.0b2

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

Deprecated
----------

* :confval:`html_codeblock_linenos_style`
* ``favicon`` and ``logo`` variable in HTML templates
* ``sphinx.directives.patches.CSVTable``
* ``sphinx.directives.patches.ListTable``
* ``sphinx.directives.patches.RSTTable``
* ``sphinx.ext.autodoc.directive.DocumenterBridge.filename_set``
* ``sphinx.ext.autodoc.directive.DocumenterBridge.warn()``
* ``sphinx.registry.SphinxComponentRegistry.get_source_input()``
* ``sphinx.registry.SphinxComponentRegistry.source_inputs``
* ``sphinx.transforms.FigureAligner``
* ``sphinx.util.pycompat.convert_with_2to3()``
* ``sphinx.util.pycompat.execfile_()``
* ``sphinx.util.smartypants``
* ``sphinx.util.typing.DirectiveOption``

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

4.0.0b1

* autodoc: Support ``bound`` argument for TypeVar
* autodoc: Support typehints for properties
* autodoc: Allow to refer to a python class using its canonical name
  when the class has two different names; a canonical name and an alias name
* autodoc: Add :confval:`autodoc_typehints_description_target` to control
  the behavior of ``autodoc_typehints=description``
* autodoc: :confval:`autodoc_docstring_signature` will continue to look
  for multiple signature lines without backslash character
* autosummary: Enable :confval:`autosummary_generate` by default
* extlinks: Allow %s in link caption string
* py domain: Add ``:canonical:`` option to python directives to describe
  the location where the object is defined
* py domain: Add :confval:`python_use_unqualified_type_names` to suppress
  the module name of the python reference if it can be resolved (experimental)
* py domain: Add :rst:dir:`py:property` directive to describe a property
* i18n: The alt text for image is translated by default (without
  :confval:`gettext_additional_targets` setting)
* html: :confval:`html_favicon` and :confval:`html_logo` now accept URL
  for the image
* html search: Support searching for 2characters word
* html theme: Allow to inherite the search page
* imgconverter: Show the error of the command availability check
* Add debug logs for change detection of sources and templates
* Emit a warning if toctree contains duplicated entries
* ``master_doc`` is now renamed to :confval:`root_doc`
* C++, add support for the C++20 spaceship operator, ``<=>``.
* 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

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

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

4.0.0b1

* autodoc: Raises a warning if function has wrong __globals__ value
* autodoc: a TypeVar imported from other module is not resolved (in
  Python 3.7 or above)
* autodoc: Failed to resolve types.TracebackType type annotation
* html: html_add_permalinks=None and html_add_permalinks="" are ignored
* html search: Paragraphs in search results are not identified as ``<p>``
* html theme: The translation of sphinx_rtd_theme does not work
* Emit a warning if a unknown domain is given for directive or role (ex.
  ``:unknown:doc:``)
* LaTeX: No wrapping for ``cpp:enumerator``
* LaTeX: backticks in code-blocks trigger latexpdf build warning (and font
  change) with late TeXLive 2019
* LaTeX: Figures with no size defined get overscaled (compared to images
  with size explicitly set in pixels) (fixed for ``'pdflatex'/'lualatex'`` only)
* LaTeX: The depth of bookmarks panel in PDF is not enough for navigation
* LaTeX: the fix to two minor Pygments LaTeXFormatter output issues ignore
  Pygments style
* LaTeX: 3.5.0 ``verbatimmaxunderfull`` setting does not work as
  expected
* LaTeX: missing line break in ``\pysigline``
* LaTeX: legacy ``\pysiglinewithargsret`` does not compute correctly
  available  horizontal space and should use a ragged right style
* LaTeX: "release" value with underscore leads to invalid LaTeX
* C++: remove the longest matching prefix in
  :confval:`cpp_index_common_prefix` instead of the first that matches.
* C, properly reject function declarations when a keyword is used
  as parameter name.
* viewcode: Failed to create back-links on parallel build
* C and C++, fix rendering of (member) function pointer types in
  function parameter lists.
* C++, fix linking of names in array declarators, pointer to member
  (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

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