Log message:
python: egg.mk: add USE_PKG_RESOURCES flag

This flag should be set for packages that import pkg_resources
and thus need setuptools after the build step.

Set this flag for packages that need it and bump PKGREVISION.

Log message:
*: bump PKGREVISION for egg.mk users

They now have a tool dependency on py-setuptools instead of a DEPENDS

Log message:
py-sphinx: updated to 4.3.2

Release 4.3.2 (released Dec 19, 2021)
=====================================

Bugs fixed
----------
* C and C++, parse fundamental types no matter the order of simple type
  specifiers.

Log message:
py-sphinx: updated to 4.3.1

Release 4.3.1 (released Nov 28, 2021)

Features added
* mathjax: Support chnaging the loading method of MathJax to “defer” via \ 
mathjax_options
Bugs fixed
* autodoc: AttributeError is raised on building document for functions decorated \ 
by functools.lru_cache
* autodoc: AttributeError is raised on building document for an object having \ 
invalid __doc__ atribute
* autodoc: Failed to process a function wrapped with functools.partial if \ 
autodoc_preserve_defaults enabled
* html: Class namespace collision between autodoc signatures and docutils-0.17
* imgmath: Crashed if the dvisvgm command failed to convert equation
* mathjax: Failed to render equations via MathJax v2. The loading method of \ 
MathJax is back to “async” method again

Log message:
py-sphinx: updated to 4.3.0

Release 4.3.0

Dependencies
Support Python 3.10

Incompatible changes
* searchindex.js: the embedded data has changed format to allow objects with the \ 
same name in different domains.
* The rendering of Python domain declarations is implemented with more docutils \ 
nodes to allow better CSS styling. It may break existing styling.
* the signature of domains.py.PyObject.get_signature_prefix() has changed to \ 
return a list of nodes instead of a plain string.
* domains.js.JSObject.display_prefix has been changed into a method \ 
get_display_prefix which now returns a list of nodes instead of a plain string.
* The rendering of Javascript domain declarations is implemented with more \ 
docutils nodes to allow better CSS styling. It may break existing styling.
* mathjax: Load MathJax via “defer” strategy

Deprecated
sphinx.ext.autodoc.AttributeDocumenter._datadescriptor
sphinx.writers.html.HTMLTranslator._fieldlist_row_index
sphinx.writers.html.HTMLTranslator._table_row_index
sphinx.writers.html5.HTML5Translator._fieldlist_row_index
sphinx.writers.html5.HTML5Translator._table_row_index

Features added
* autodoc: Support asynchronous generator functions
* autodoc: autodoc-process-bases supports to inject reST snippet as a base class
* C, added new info-field retval for c:function and c:macro.
C++, added new info-field retval for cpp:function.
* i18n: Add gettext_allow_fuzzy_translations to allow “fuzzy” messages for \ 
translation
* More CSS classes on Python domain descriptions
* More CSS classes on Javascript domain descriptions
* Revert the removal of add_stylesheet() API. It will be kept until the \ 
Sphinx-6.0 release
* add intersphinx_disabled_reftypes for disabling interphinx resolution of \ 
cross-references that do not have an explicit inventory specification. Specific \ 
types of cross-references can be disabled, e.g., std:doc or all cross-references \ 
in a specific domain, e.g., std:*.
* Allow to suppress “toctree contains reference to excluded document” \ 
warnings using suppress_warnings

Bugs fixed
* autodoc: Failed to build cross references if primary_domain is not ‘py’
* autodoc: Crashed on getting source info from problematic object
* autodoc: mocked object having doc comment is warned unexpectedly
* autodoc: return type field is not generated even if \ 
autodoc_typehints_description_target is set to “documented” when its \ 
info-field-list contains :returns: field
* autodoc: The base class for a subclass of mocked object is incorrect
* autodoc: Incorrect base class detection for the subclasses of the generic class
* autodoc: memory addresses are shown for aliases
* autodoc: Failed to detect type annotation for slots attribute
* autodoc: Crashed if classmethod does not have __func__ attribute
* autodoc: autodoc_inherit_docstrings does not effect to overriden classmethods
* autodoc: autodoc_preserve_defaults does not support hexadecimal numeric
* autosummary: Failed to build summary table if primary_domain is not ‘py’
* html: Fix download file with special characters
* html: Wrong styles for even/odd rows in nested tables
* html: parameter name and its type annotation are not separated in HTML
* HTML search: when objects have the same name but in different domains, return \ 
all of them as result instead of just one.
* intersphinx: references on the file in sub directory are broken
* LaTeX: hlist is rendered as a list containing “aggedright” text
* linkcheck: file extension was shown twice in warnings
* py domain: An index entry with parens was registered for py:method directive \ 
with :property: option
* py domain: Literal typehint was converted to a cross reference when \ 
autodoc_typehints='description'
* needs_extension failed to check double-digit version correctly
* Fix code` does not recognize :class: option
* Fix for logging handler flushing warnings in the middle of the docs build
* Fix warnings without subtype being incorrectly suppressed
Intersphinx, for unresolved references with an explicit inventory, e.g., \ 
proj:myFunc, leave the inventory prefix in the unresolved text.

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

Log message:
textproc: Replace RMD160 checksums with BLAKE2s checksums

All checksums have been double-checked against existing RMD160 and
SHA512 hashes

Unfetchable distfiles (fetched conditionally?):
./textproc/convertlit/distinfo clit18src.zip

Log message:
textproc: Remove SHA1 hashes for distfiles

Log message:
py-sphinx: updated to 3.5.4

Release 3.5.4 (released Apr 11, 2021)
=====================================

Dependencies
------------
* Restrict docutils to 0.16

Bugs fixed
----------
* autodoc: Async staticmethods and classmethods are considered as non
  async coroutine-functions with Python3.10
* html theme: The style are not applied with docutils-0.17
  - toctree captions
  - The content of ``sidebar`` directive
  - figures

Log message:
py-sphinx: updated to 3.5.3

Release 3.5.3 (released Mar 20, 2021)
=====================================

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

* using UNIX path separator in image directive confuses Sphinx on Windows

Release 3.5.2 (released Mar 06, 2021)
=====================================

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

* i18n: Crashed by broken translation messages in ES, EL and HR
* LaTeX: A custom LaTeX builder fails with unknown node error
* Exceptions raised in a Directive cause parallel builds to hang

Release 3.5.1 (released Feb 16, 2021)
=====================================

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

* autodoc: AttributeError is raised on assigning __annotations__ on
  read-only class
* html: minified js stemmers not included in the distributed package
* html: AttributeError is raised if CSS/JS files are installed via
  :confval:`html_context`
* viewcode: ExtensionError is raised on incremental build after
  unparsable python module found

Release 3.5.0 (released Feb 14, 2021)
=====================================

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

* LaTeX: ``multicol`` (it is anyhow a required part of the official latex2e
  base distribution)

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

* Update Underscore.js to 1.12.0
* html: The config variable ``html_add_permalinks`` is replaced by
  :confval:`html_permalinks` and :confval:`html_permalinks_icon`

Deprecated
----------

* pending_xref node for viewcode extension
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.good``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers``
* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue``
* ``sphinx.builders.linkcheck.node_line_or_0()``
* ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
* ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter``
* ``sphinx.ext.autodoc.importer.get_module_members()``
* ``sphinx.ext.autosummary.generate._simple_info()``
* ``sphinx.ext.autosummary.generate._simple_warn()``
* ``sphinx.writers.html.HTMLTranslator.permalink_text``
* ``sphinx.writers.html5.HTML5Translator.permalink_text``

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

* autodoc: autodata and autoattribute directives does not show right-hand
  value of the variable if docstring contains ``:meta hide-value:`` in
  info-field-list
* autodoc: Default values of overloaded functions are taken from actual
  implementation if they're ellipsis
* autodoc: Support type union operator (PEP-604) in Python 3.10 or above
* autodoc: Allow to extend :confval:`autodoc_default_options` via
  directive options
* html: kbd role generates customizable HTML tags for compound keys
* html: Allow to change the order of JS/CSS via ``priority`` parameter
  for :meth:`Sphinx.add_js_file()` and :meth:`Sphinx.add_css_file()`
* html: Allow to add JS/CSS files to the specific page when an extension
  calls ``app.add_js_file()`` or ``app.add_css_file()`` on
  :event:`html-page-context` event
* html: Allow to use HTML permalink texts via
  :confval:`html_permalinks_icon`
* html: Add permalink icons to glossary terms
* html search: performance issue with massive lists
* html search: Update JavaScript stemmer code to the latest version of
  Snowball (v2.1.0)
* i18n: Allow to translate heading syntax in MyST-Parser
* imgconverter: Skip availability check if builder supports the image
  type
* napoleon: Allow to change the style of custom sections using
  :confval:`napoleon_custom_styles`
* napoleon: Type definitions in Google style docstrings are rendered as
  references when :confval:`napoleon_preprocess_types` enabled
* mathjax: Include mathjax.js only on the document using equations
* py domain: Support type union operator (PEP-604)
* std domain: cross-reference for a rubric having inline item is broken
* std domain: Optimize case-insensitive match of term
* viewcode: Support incremental build
* Add :confval:`project_copyright` as an alias of :confval:`copyright`
* Now :confval:`highlight_language` supports multiple languages
* :rst:dir:`code-block` and :rst:dir:`literalinclude` supports automatic
  dedent via no-argument ``:dedent:`` option
* C++, also hyperlink operator overloads in expressions and alias declarations.
* Allow production lists to refer to tokens from other production groups
* Show what extension (or module) caused it on errors on event handler
* C++: add ``maxdepth`` option to :rst:dir:`cpp:alias` to insert nested
  declarations.
* C, add ``noroot`` option to :rst:dir:`c:alias` to render only nested
  declarations.
* C++, add ``noroot`` option to :rst:dir:`cpp:alias` to render only nested
  declarations.

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

* apidoc: namespace module file is not generated if no submodules there
* autodoc: inherited-members doesn't work for instance attributes on super
  class
* autodoc: ``:meta public:`` does not effect to variables
* autodoc: empty __all__ attribute is ignored
* autodoc: Failed to resolve struct.Struct type annotation
* autodoc: All variable comments in the module are ignored if the module
  contains invalid type comments
* autodoc: Default values for overloaded functions are rendered as string
* autodoc: crashes when mocked decorator takes arguments
* autodoc: Uninitialized attributes in superclass are recognized as
  undocumented
* autodoc: Failed to generate document if target module contains an
  object that raises an exception on ``hasattr()``
* autosummary: mocked modules are documented as empty page when using
  :recursive: option
* graphviz: Image node is not rendered if graph file is in subdirectory
* html: kbd role produces incorrect HTML when compound-key separators (-,
  + or ^) are used as keystrokes
* html: A type warning for html_use_opensearch is shown twice
* html: kbd role with "Caps Lock" rendered incorrectly
* html search: fix searching for terms containing + (Requires a custom
  search language that does not split on +)
* html theme: Could not override globaltoc_maxdepth in theme.conf
* html: consecutive spaces are displayed as single space
* i18n: crashes with KeyError when translation message adds a new auto
  footnote reference
* linkcheck: Fix race condition that could lead to checking the
  availability of the same URL twice
* linkcheck: The docname for each hyperlink is not displayed
* sphinx-quickstart: questionare got Mojibake if libreadline unavailable
* texinfo: image files on the different directory with document are not
  copied
* todo: Cross references in todolist get broken
* viewcode: module pages are generated for epub on incremental build
* viewcode: anchors are generated in incremental build after singlehtml
* viewcode: highlighted code is generated even if not referenced
* :confval:`highlight_options` is not working
* C, fix intersphinx lookup types for names in declarations.
* C, C++: in general fix intersphinx and role lookup types.
* :confval:`html_last_updated_fmt` does not support UTC offset (%z)
* :confval:`html_last_updated_fmt` generates wrong time zone for %Z
* ``download`` role creates duplicated copies when relative path is
  specified
* (fifth item): LaTeX: footnotes from captions are not clickable,
  and for manually numbered footnotes only first one with same number is
  an hyperlink
* LaTeX with French babel and memoir crash: "Illegal parameter number
  in definition of ``\FNH@prefntext``"
* LaTeX (docs): A potential display bug with the LaTeX generation step
  in Sphinx (how to generate one-column index)
* LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX
* LaTeX: The :rst:role:`index` role and the glossary generate duplicate
  entries in the LaTeX index (if both used for same term)
* LaTeX: wrong internal links in pdf to captioned code-blocks when
  :confval:`numfig` is not True
* LaTeX: some indexed terms are ignored when using xelatex engine
  (or pdflatex and :confval:`latex_use_xindy` set to True) with memoir class
* LaTeX: URLs as footnotes fail to show in PDF if originating from
  inside function type signatures
* LaTeX: long words in narrow columns may not be hyphenated
* LaTeX: ``\titleformat`` last argument in sphinx.sty should be
  bracketed, not braced (and is anyhow not needed)
* LaTex: code-block printed out of margin (see the opt-in LaTeX syntax
  boolean :ref:`verbatimforcewraps <latexsphinxsetupforcewraps>` for use via
  the :ref:`'sphinxsetup' <latexsphinxsetup>` key of ``latex_elements``)
* LaTeX: Remove substitution_reference nodes from doctree only on LaTeX
  builds
* LaTeX: Restructure the index nodes inside title nodes only on LaTeX
  builds
* LaTeX: potentially critical low level TeX coding mistake has gone
  unnoticed so far
* C, :rst:dir:`c:alias` skip symbols without explicit declarations
  instead of crashing.
* C, :rst:dir:`c:alias` give a warning when the root symbol is not declared.
* C, ``expr`` role should start symbol lookup in the current scope.

Release 3.4.3 (released Jan 08, 2021)
=====================================

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

* autodoc: Failed to generate document if target module contains an
  object that raises an exception on ``hasattr()``

Release 3.4.2 (released Jan 04, 2021)
=====================================

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

* autodoc: Classes that inherit mocked class are not documented
* autodoc: The ``autodoc-process-docstring`` event is emitted to the
  non-datadescriptors unexpectedly
* autodoc: AttributeError is raised on non-class object is passed to
  autoclass directive

Release 3.4.1 (released Dec 25, 2020)
=====================================

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

* autodoc: AttributeError is raised when using forward-reference type
  annotations
* autodoc: TypeError is raised on checking slots attribute
* autodoc: Instance attributes are incorrectly added to Parent class
* autodoc: The ``autodoc-process-docstring`` event is emitted to the
  alias classes unexpectedly
* autodoc: Unnecessary object comparision via ``__eq__`` method
* linkcheck: Fix PriorityQueue crash when link tuples are not
  comparable

Release 3.4.0 (released Dec 20, 2020)
=====================================

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

* autodoc: the signature of class constructor will be shown for decorated
  classes, not a signature of decorator

Deprecated
----------

* The ``follow_wrapped`` argument of ``sphinx.util.inspect.signature()``
* The ``no_docstring`` argument of
  ``sphinx.ext.autodoc.Documenter.add_content()``
* ``sphinx.ext.autodoc.Documenter.get_object_members()``
* ``sphinx.ext.autodoc.DataDeclarationDocumenter``
* ``sphinx.ext.autodoc.GenericAliasDocumenter``
* ``sphinx.ext.autodoc.InstanceAttributeDocumenter``
* ``sphinx.ext.autodoc.SlotsAttributeDocumenter``
* ``sphinx.ext.autodoc.TypeVarDocumenter``
* ``sphinx.ext.autodoc.importer._getannotations()``
* ``sphinx.ext.autodoc.importer._getmro()``
* ``sphinx.pycode.ModuleAnalyzer.parse()``
* ``sphinx.util.osutil.movefile()``
* ``sphinx.util.requests.is_ssl_error()``

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

* autodoc: Allow to determine whether a member not included in
  ``__all__`` attribute of the module should be documented or not via
  :event:`autodoc-skip-member` event
* autodoc: Parameters for generic class are not shown when super class is
  a generic class and show-inheritance option is given (in Python 3.7 or above)
* autodoc: Add ``Documenter.config`` as a shortcut to access the config object
* autodoc: Add Optional[t] to annotation of function and method if a default
  value equal to None is set.
* autodoc: Add ``:no-value:`` option to :rst:dir:`autoattribute` and
  :rst:dir:`autodata` directive to suppress the default value of the variable
* autodoc: Support custom types defined by typing.NewType
* napoleon: Add :confval:`napoleon_attr_annotations` to merge type hints
  on source code automatically if any type is specified in docstring
* napoleon: Support numpydoc's "Receives" section
* Add a new event :event:`warn-missing-reference` to custom warning
  messages when failed to resolve a cross-reference
* Emit a detailed warning when failed to resolve a ``:ref:`` reference
* linkcheck: The builder now handles rate limits. See
  :confval:`linkcheck_retry_on_rate_limit` for details.

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

* autodoc: autodoc does not respect __signature__ of the class
* autodoc: the location of the warning is incorrect for inherited method
* autodoc: the signature of class constructor is incorrect if the class
  is decorated
* autodoc: :confval:`autodoc_type_aliases` does not effect to variables
  and attributes
* autodoc: autodata directive can't create document for PEP-526 based
  type annotated variables
* autodoc: autoattribute directive can't create document for PEP-526
  based uninitalized variables
* autodoc: autoattribute could not create document for __slots__
  attributes
* autodoc: autoattribute could not create document for a GenericAlias as
  class attributes correctly
* autodoc: autoattribute could not create document for a commented
  attribute in alias class
* autodoc: autodoc_type_aliases doesn't work when autodoc_typehints is
  set to "description"
* autodoc: autodoc_type_aliases doesn't work for the type annotation to
  instance attributes
* autodoc: autodata and autoattribute directives do not display type
  information of TypeVars
* autodoc: references to builtins not working in class aliases
* autodoc:  ``__bool__`` method could be called
* autodoc: A typehint for the instance variable having type_comment on
  super class is not displayed
* autodoc: a __slots__ attribute is not documented even having docstring
* autodoc: inherited-members doesn't work for instance attributes on super
  class
* autosummary: non utf-8 reST files are generated when template contains
  multibyte characters
* autosummary: summary extraction splits text after "el at." unexpectedly
* html: Wrong url_root has been generated on a document named "index"
* html search: Do not load ``language_data.js`` in non-search pages
* i18n: ``-D gettext_compact=0`` is no longer working
* graphviz: The layout option for graph and digraph directives don't work
* linkcheck: Use GET when HEAD requests cause Too Many Redirects, to
  accommodate infinite redirect loops on HEAD
* Makefile: ``make clean`` with empty BUILDDIR is dangerous
* py domain: ``:type:`` and ``:rtype:`` gives false ambiguous class
  lookup warnings
* std domain: Failed to parse an option that starts with bracket
* LaTeX: Prevent page brake in the middle of a seealso
* C, fix copying of AliasNode.

Release 3.3.1 (released Nov 12, 2020)
=====================================

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

* autodoc: autoclass directive became slower than Sphinx-3.2
* autosummary: raise PycodeError when documenting python package
  without __init__.py
* autosummary: autosummary_mock_imports causes slow down builds
* C, properly initialize attributes in empty symbols.
* i18n: Put system locale path after the paths specified by configuration

Release 3.3.0 (released Nov 02, 2020)
=====================================

Deprecated
----------

* ``sphinx.builders.latex.LaTeXBuilder.usepackages``
* ``sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref``
* ``sphinx.ext.autodoc.SingledispatchFunctionDocumenter``
* ``sphinx.ext.autodoc.SingledispatchMethodDocumenter``

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

* html: Show a better error message for failures on copying
  html_static_files
* C: added a ``maxdepth`` option to :rst:dir:`c:alias` to insert
  nested declarations.
* LaTeX: Allow to add LaTeX package via ``app.add_latex_package()`` until
  just before writing .tex file
* manpage: Add :confval:`man_make_section_directory` to make a section
  directory on build man page
* epub: Allow to suppress "duplicated ToC entry found" warnings from epub
  builder using :confval:`suppress_warnings`.
* sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep` option
* sphinx.testing: Register public markers in sphinx.testing.fixtures
* napoleon: use the obj role for all See Also items
* napoleon: Apply :confval:`napoleon_preprocess_types` to every field
* C and C++, show line numbers for previous declarations when duplicates are
  detected.
* Remove substitution_reference nodes from doctree only on LaTeX builds

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

* i18n: Add support for having single text domain
* i18n: Failed to override system message translation
* autodoc: AttributeError is raised when False value is passed to
  autodoc_default_options
* autodoc: functools.cached_property is not considered as a property
* autodoc: parsing error is raised if some extension replaces docstring
  by string not ending with blank lines
* autodoc: Wrong constructor signature for the class derived from
  typing.Generic
* autodoc: TypeError is raised when annotation has invalid __args__
* autodoc: Tuple in default value is wrongly rendered
* autodoc: type aliases break type formatting of autoattribute
* autodoc: can't detect overloaded methods defined in other file
* autodoc: single-string __slots__ is not handled correctly
* autodoc: autodoc_typehints='none' does not effect to overloaded functions
* napoleon: description is disappeared when it contains inline literals
* napoleon: Potential of regex denial of service in google style docs
* LaTeX: pxjahyper loaded even when latex_engine is not platex
* LaTeX: 'oneside' classoption causes build warning
* intersphinx: Potential of regex denial of service by broken inventory
* sphinx-build: missing and redundant spacing (and etc) for console
  output on building
* imgconverter: Check availability of imagemagick many times
* py domain: number in default argument value is changed from hexadecimal
  to decimal
* html: Prevent arrow keys changing page when button elements are focused
* html search: Fix unnecessary load of images when parsing the document
* html theme: Line numbers misalign with code lines
* The highlight warning has wrong location in some builders (LaTeX,
  singlehtml and so on)
* Eliminate Fancyhdr build warnings for oneside documents
* Failed to refer a token in productionlist if it is indented
* linkcheck: Report HTTP errors when ``linkcheck_anchors`` is ``True``
* linkcheck: take source directory into account for local files
* linkcheck: ``tel:`` schema hyperlinks are detected as errors
* linkcheck: An exit status is incorrect when links having unsupported
  schema found
* C, add missing items to internal object types dictionary,
  e.g., preventing intersphinx from resolving them.
* C, fix anon objects in intersphinx.
* C++, properly reject functions as duplicate declarations if a
  non-function declaration of the same name already exists.
* C, fix references to function parameters.
  Link to the function instead of a non-existing anchor.
* figure numbers are unexpectedly assigned to uncaptioned items
* make "inline" line numbers un-selectable

Testing
--------

* Support parallel build in sphinx.testing

Release 3.2.1 (released Aug 14, 2020)
=====================================

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

* napoleon: Add :confval:`napoleon_preprocess_types` to enable the type
  preprocessor for numpy style docstrings
* C and C++, parse function attributes after parameters and qualifiers.

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

* napoleon: Crashes during processing C-ext module
* napoleon: "Inline literal start-string without end-string" warning in
  Numpy style Parameters section
* autodoc: KeyError is raised on documenting an attribute of the broken
  class
* autodoc: AttributeError is raised on documenting an attribute on Python
  3.5.2
* autodoc: NameError is raised when target code uses ``TYPE_CHECKING``
* C++, fix parsing of template template paramters

Release 3.2.0 (released Aug 08, 2020)
=====================================

Deprecated
----------

* ``sphinx.ext.autodoc.members_set_option()``
* ``sphinx.ext.autodoc.merge_special_members_option()``
* ``sphinx.writers.texinfo.TexinfoWriter.desc``
* C, parsing of pre-v3 style type directives and roles, along with the options
  :confval:`c_allow_pre_v3` and :confval:`c_warn_on_allowed_pre_v3`.

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

* autodoc: Allow overriding of exclude-members in skip-member function
* autodoc: ``:private-member:`` can take an explicit list of member names
  to be documented
* autosummary: Add :confval:`autosummary_filename_map` to avoid conflict
  of filenames between two object with different case
* autosummary: Support instance attributes as a target of autosummary
  directive
* html: Add :confval:`html_codeblock_linenos_style` to change the style
  of line numbers for code-blocks
* C and C++, support parameterized GNU style attributes.
* napoleon: Add aliases Warn and Raise.
* napoleon: parse type strings and make them hyperlinks as possible.  The
  conversion rule can be updated via :confval:`napoleon_type_aliases`
* napoleon: Create a hyperlink for each the type of parameter when
  :confval:`napoleon_use_params` is False
* C, added :rst:dir:`c:alias` directive for inserting copies
  of existing declarations.
* html: inventory is broken if the docname contains a space
* html search: Allow searching for numbers
* html theme: Add a new option :confval:`globaltoc_maxdepth` to control
  the behavior of globaltoc in sidebar
* i18n: Optimize the dependencies check on bootstrap
* i18n: :confval:`figure_language_filename` supports ``docpath`` token
* linkcheck: Support checks for local links
* setuptools: Link verbosity to distutils' -v and -q option
* doctest: Add ``:trim-doctest-flags:`` and ``:no-trim-doctest-flags:``
  options to doctest, testcode and testoutput directives
* add ``:noindexentry:`` to the Python, C, C++, and Javascript domains.
  Update the documentation to better reflect the relationship between this option
  and the ``:noindex:`` option.
* C, add possibility of parsing of some pre-v3 style type directives and
  roles and try to convert them to equivalent v3 directives/roles.
  Set the new option :confval:`c_allow_pre_v3` to ``True`` to enable this.
  The warnings printed from this functionality can be suppressed by setting
  :confval:`c_warn_on_allowed_pre_v3`` to ``True``.
  The functionality is immediately deprecated.
* C, add support for named variadic macro arguments.
* Allow to suppress "self referenced toctrees" warning

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

* autodoc: TypeError is raised on mocking generic-typed classes
* autodoc: function signature is not shown when the function has a
  parameter having ``inspect._empty`` as its default value
* autodoc: type annotations for overloaded functions are not resolved
* autodoc: An instance attribute cause a crash of autofunction directive
* autodoc: ``private-members`` option does not work for class attributes
* autodoc: Generator type annotation is wrongly rendered in py36
* autodoc: An uninitialized annotated instance variable is not documented
  when ``:inherited-members:`` option given
* autodoc: A type hint for the instance variable defined at parent class
  is not shown in the document of the derived class
* autodoc: An annotated instance variable on super class is not
  documented when derived class has other annotated instance variables
* autosummary: cannot handle umlauts in function names
* autosummary: Failed to extract summary line when abbreviations found
* autosummary: Failed to extract correct summary line when docstring
  contains a hyperlink target
* autosummary: "Module attributes" header is not translatable
* apidoc: An extra newline is generated at the end of the rst file if a
  module has submodules
* napoleon: decorated special methods are not shown
* napoleon: parameters are not escaped for combined params in numpydoc
* napoleon: multiple paramaters declaration in numpydoc was wrongly
  recognized when napoleon_use_params=True
* LaTeX: ``numfig_secnum_depth > 1`` leads to wrong figure links
* html theme: XML-invalid files were generated
* gettext: Wrong source info is shown when using rst_epilog
* linkcheck: HEAD requests are not used for checking
* i18n: Failed to add an explicit title to ``:ref:`` role on translation
* py domain: failed to resolve a type annotation for the attribute
* py domain: failed to parse a type annotation containing ellipsis
* std domain: option directive does not generate old node_id compatible
  with 2.x or older
* i18n: The content of ``math`` directive is interpreted as reST on
  translation
* i18n: The ``root`` element for :confval:`figure_language_filename` is
  not a path that user specifies in the document
* texinfo: TypeError is raised for nested object descriptions
* texinfo: a warning not supporting desc_signature_line node is shown
* :rst:role:`abbr` role without an explanation will show the explanation
  from the previous abbr role
* graphviz: graphviz.css was copied on building non-HTML document
* C and C++, removed ``noindex`` directive option as it did
  nothing.
* Duplicated node IDs are generated if node has multiple IDs
* Symbols sections are appeared twice in the index page
* Fix circular import in sphinx.addnodes
* CSS: make "highlight" selector more robust
* C++, parse non-type template parameters starting with
  a dependent qualified name.
* C, don't deepcopy the entire symbol table and make a mess every time an
  enumerator is handled.

Release 3.1.2 (released Jul 05, 2020)
=====================================

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

* autodoc: the signature of base function will be shown for decorated
  functions, not a signature of decorator

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

* autodoc: Failed to detect module when relative module name given
* autodoc: AttributeError is raised when non-class object is given to
  the autoclass directive
* autodoc: KeyError is raised for invalid mark up when autodoc_typehints
  is 'description'
* autodoc: crashed if the target name matches to both an attribute and
  module that are same name
* autodoc: function signature becomes ``(*args, **kwargs)`` if the
  function is decorated by generic decorator
* autosummary: generates broken stub files if the target code contains
  an attribute and module that are same name
* viewcode: Failed to resolve viewcode references on 3rd party builders
* html theme: List items have extra vertical space
* html theme: Undesired interaction between "overflow" and \ 
"float"

Release 3.1.1 (released Jun 14, 2020)
=====================================

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

* napoleon: a type for attribute are represented as typed field

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

* autodoc: Show detailed warning when type_comment is mismatched with its
  signature

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

* autodoc: Warnings raised on variable and attribute type annotations
* autodoc: EOFError is raised on parallel build
* autodoc: TypeError is raised for overloaded C-ext function
* autodoc: an object which descriptors returns is unexpectedly documented
* autodoc: wrong signature is shown for the function using contextmanager
* autosummary: generates broken stub files if the target code contains
  an attribute and module that are same name
* napoleon: Warnings raised on variable and attribute type annotations
* sphinx.util.inspect causes circular import problem

Release 3.1.0 (released Jun 08, 2020)
=====================================

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

* mathjax: Update to 2.7.5

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

* imgconverter: Invoke "magick convert" command by default on Windows

Deprecated
----------

* The first argument for sphinx.ext.autosummary.generate.AutosummaryRenderer has
  been changed to Sphinx object
* ``sphinx.ext.autosummary.generate.AutosummaryRenderer`` takes an object type
  as an argument
* The ``ignore`` argument of ``sphinx.ext.autodoc.Documenter.get_doc()``
* The ``template_dir`` argument of ``sphinx.ext.autosummary.generate.
  AutosummaryRenderer``
* The ``module`` argument of ``sphinx.ext.autosummary.generate.
  find_autosummary_in_docstring()``
* The ``builder`` argument of ``sphinx.ext.autosummary.generate.
  generate_autosummary_docs()``
* The ``template_dir`` argument of ``sphinx.ext.autosummary.generate.
  generate_autosummary_docs()``
* The ``ignore`` argument of ``sphinx.util.docstring.prepare_docstring()``
* ``sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()``
* ``sphinx.util.rpartition()``

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

* LaTeX: Make the ``toplevel_sectioning`` setting optional in LaTeX theme
* LaTeX: Allow to override papersize and pointsize from LaTeX themes
* LaTeX: Add :confval:`latex_theme_options` to override theme options
* Allow to suppress "circular toctree references detected" warnings using
  :confval:`suppress_warnings`
* C, added scope control directives, :rst:dir:`c:namespace`,
  :rst:dir:`c:namespace-push`, and :rst:dir:`c:namespace-pop`.
* autodoc: Suppress default value for instance attributes
* autodoc: consider a member public if docstring contains
  ``:meta public:`` in info-field-list
* autodoc: Allow to generate docs for singledispatch functions by
  py:autofunction
* autodoc: Support final classes and methods
* autodoc: Support signatures defined by ``__new__()``, metaclasses and
  builtin base classes
* autodoc: Support multiple signatures on docstring
* autodoc: Support GenericAlias in Python 3.7 or above
* autodoc: Support overloaded functions
* autodoc: Support TypeVar
* autosummary: headings in generated documents are not translated
* autosummary: Add ``:caption:`` option to autosummary directive to set a
  caption to the toctree
* autosummary: Support module attributes
* autosummary: Add ``:recursive:`` option to autosummary directive
  to generate stub files recursively
* autosummary: Add :confval:`autosummary_context` to add template
  variables for custom templates
* html: Support nested <kbd> elements
* html theme: Add right margin to footnote/citation labels
* html theme: CSS spacing for code blocks with captions and line
  numbers
* html theme: Add new options :confval:`globaltoc_collapse` and
  :confval:`globaltoc_includehidden` to control the behavior of globaltoc in
  sidebar
* html theme: Avoid clashes between sidebar and other blocks
* html theme: Relbar breadcrumb should contain current page
* html theme: A canonical URL is not escaped
* html theme: Avoid whitespace at the beginning of genindex.html
* html theme: Add a "clearer" at the end of the "body"
* html theme: Make admonition/topic/sidebar scrollable
* html theme: Add top and bottom margins to tables
* html theme: Add viewport meta tag for basic theme
* html theme: classic: default codetextcolor/codebgcolor doesn't override
  Pygments
* C and C++: allow semicolon in the end of declarations.
* C++, parse parameterized noexcept specifiers.
* C++, parse expressions with user-defined literals.
* C++, parse trailing return types.
* py domain: Add ``:final:`` option to :rst:dir:`py:class:`,
  :rst:dir:`py:exception:` and :rst:dir:`py:method:` directives
* py domain: Change a type annotation for variables to a hyperlink
* std domain: :rst:dir:`option` directive support arguments in the form
  of ``foo[=bar]``
* napoleon: a type for attribute are represented like type annotation
* napoleon: overescaped trailing underscore on attribute
* linkcheck: Add :confval:`linkcheck_request_headers` to send custom HTTP
  headers for specific host
* setuptools: Support ``--verbosity`` option
* Add ``allowed_exceptions`` parameter to ``Sphinx.emit()`` to allow
  handlers to raise specified exceptions
* C++, parse (trailing) requires clauses.

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

* autodoc: incremental build does not work for imported objects
* autodoc: annotations not to be shown for descriptors
* autodoc: Decorated inherited method has no documentation
* autodoc: The change of autodoc-process-docstring for variables is
  cached unexpectedly
* autodoc: misdetects a sync function is async
* autodoc: failed to detect a classmethod on Enum class
* autodoc: a typehint contains spaces is wrongly rendered under
  autodoc_typehints='description' mode
* autodoc: failed to import nested class
* autodoc: does not render correct signatures for built-in functions
* autodoc: ``Optional[Union[foo, bar]]`` is presented as
  ``Union[foo, bar, None]``
* autodoc: autofunction emits an unfriendly warning if an invalid object
  specified
* autodoc: undecorated signature is shown for decorated functions
* autodoc: typo in the default value of autodoc_member_order
* autodoc: wrong value for :member-order: option is ignored silently
* autodoc: member-order="bysource" does not work for C module
* autodoc: member-order="bysource" does not work for a module having
  __all__
* autodoc: wrong retann value is passed to a handler of
  autodoc-proccess-signature
* autodoc: fails with ValueError when processing numpy objects
* autodoc: TypeError is raised on documenting singledispatch function
* autosummary: a nested class is indexed as non-nested class
* autosummary: autosummary directive emits warnings twices if failed to
  import the target module
* autosummary: The template variable "members" contains imported members
  even if :confval:`autossummary_imported_members` is False
* autosummary: The location of import failure warning is missing
* sphinx-autogen: crashes when custom template uses inheritance
* sphinx-autogen: crashes when template uses i18n feature
* sphinx-build: Wrong error message when outdir is not directory
* sphinx-quickstart: Fix multiple directory creation for nested relpath
* html: Bad alignment of equation links
* html theme: some themes does not respect background color of Pygments
  style (agogo, haiku, nature, pyramid, scrolls, sphinxdoc and traditional)
* html theme: inconsistent padding in admonitions
* napoleon: bad parsing of inline code in attribute docstrings
* imgconverter: runs imagemagick once unnecessary for builders not
  supporting images
* incorrectly renders consecutive backslashes for docutils-0.16
* handle errors on event handlers
* LaTeX: EN DASH disappears from PDF bookmarks in Japanese documents
* LaTeX: Anonymous indirect hyperlink target causes duplicated labels
* LaTeX: pdflatex crashed when URL contains a single quote
* py domain: The default value for positional only argument is not shown
* coverage: Add :confval:`coverage_show_missing_items` to show coverage
  result to console
* C++, fix rendering and xrefs in nested names explicitly starting
  in global scope, e.g., ``::A::B``.
* C, fix rendering and xrefs in nested names explicitly starting
  in global scope, e.g., ``.A.B``.
* C and C++, don't crash during display stringification of unary
  expressions and fold expressions.

Release 3.0.4 (released May 27, 2020)
=====================================

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

* autodoc: parametrized types are shown twice for generic types
* autodoc: system defined TypeVars are shown in Python 3.9
* html: Updated jQuery version from 3.4.1 to 3.5.1 for security reasons
* md5 fails when OpenSSL FIPS is enabled
* release package does not contain ``CODE_OF_CONDUCT``

Release 3.0.3 (released Apr 26, 2020)
=====================================

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

* C, parse array declarators with static, qualifiers, and VLA specification.

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

* autodoc: crashes if target object raises an error on accessing
  its attributes

Release 3.0.2 (released Apr 19, 2020)
=====================================

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

* C, parse attributes and add :confval:`c_id_attributes`
  and :confval:`c_paren_attributes` to support user-defined attributes.

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

* py domain: fails with IndexError for empty tuple in type annotation
* py domain: keyword-only arguments are documented as having a default of
  None
* std domain: :rst:role:`term` role could not match case-insensitively
* autodoc: empty tuple in type annotation is not shown correctly
* autodoc: Sphinx builds has been slower since 3.0.0 on mocking
* C++, fix spacing issue in east-const declarations.
* LaTeX: Xindy language options were incorrect
* sphinx crashes with ImportError on python3.5.1

Release 3.0.1 (released Apr 11, 2020)
=====================================

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

* std domain: :rst:dir:`term` role becomes case sensitive

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

* py domain: a reference to class ``None`` emits a nitpicky warning
* py domain: a return annotation ``None`` in the function signature is
  not converted to a hyperlink when using intersphinx
* std domain: duplication warning for glossary terms is case insensitive
* C++, fix merging overloaded functions in parallel builds.
* autodoc: fails with ValueError when using autodoc_mock_imports
* autodoc: ``autodoc_typehints='description'`` doesn't suppress typehints
  in signature for classes/methods
* autodoc: fails with AttributeError when an object returns non-string
  object as a ``__doc__`` member
* crashed when giving a non-string object to logger
* html theme: Do not include xmlns attribute with HTML 5 doctype
* html theme: Escape some links in HTML templates

Release 3.0.0 (released Apr 06, 2020)
=====================================

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

3.0.0b1

* LaTeX: drop dependency on :program:`extractbb` for image inclusion in
  Japanese documents as ``.xbb`` files are unneeded by :program:`dvipdfmx`
  since TeXLive2015
* babel-2.0 or above is available (Unpinned)

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

3.0.0b1

* Drop features and APIs deprecated in 1.8.x
* autosummary: stub files are overwritten automatically by default.  see
  :confval:`autosummary_generate_overwrite` to change the behavior
* autodoc: the members of ``object`` class are not documented by default
  when ``:inherited-members:`` and ``:special-members:`` are given.
* py domain: ``meta`` fields in info-field-list becomes reserved.  They
  are not displayed on output document now
* py domain: doctree of desc_parameterlist has been changed.  The
  argument names, annotations and default values are wrapped with inline node
* The structure of ``sphinx.events.EventManager.listeners`` has changed
* Due to the scoping changes for :rst:dir:`productionlist` some uses of
  :rst:role:`token` must be modified to include the scope which was previously
  ignored.
* Internal data structure of Python, reST and standard domains have
  changed.  The node_id is added to the index of objects and modules.  Now they
  contains a pair of docname and node_id for cross reference.
* C++ domain: Non intended behavior is removed such as ``say_hello_``
  links to ``.. cpp:function:: say_hello()``
* js domain: Non intended behavior is removed such as ``parseInt_`` links
  to ``.. js:function:: parseInt``
* rst domain: Non intended behavior is removed such as ``numref_`` links
  to ``.. rst:role:: numref``
* py domain: Non intended behavior is removed such as ``say_hello_``
  links to ``.. py:function:: say_hello()``
* py domain: Drop special cross reference helper for exceptions,
  functions and methods
* The C domain has been rewritten, with additional directives and roles.
  The existing ones are now more strict, resulting in new warnings.
* The attribute ``sphinx_cpp_tagname`` in the ``desc_signature_line`` node
  has been renamed to ``sphinx_line_type``.
* double backslashes in domain directives are no longer replaced by
  single backslashes as default. A new configuration value
  :confval:`strip_signature_backslash` can be used by users to reenable it.

3.0.0 final

* ``sphinx.util.inspect.unwrap()`` is renamed to ``unwrap_all()``

Deprecated
----------

3.0.0b1

* ``desc_signature['first']``
* ``sphinx.directives.DescDirective``
* ``sphinx.domains.std.StandardDomain.add_object()``
* ``sphinx.domains.python.PyDecoratorMixin``
* ``sphinx.ext.autodoc.get_documenters()``
* ``sphinx.ext.autosummary.process_autosummary_toc()``
* ``sphinx.parsers.Parser.app``
* ``sphinx.testing.path.Path.text()``
* ``sphinx.testing.path.Path.bytes()``
* ``sphinx.util.inspect.getargspec()``
* ``sphinx.writers.latex.LaTeXWriter.format_docclass()``

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

3.0.0b1

* autosummary: Add :confval:`autosummary_generate_overwrite` to overwrite
  old stub file
* autodoc: ``:inherited-members:`` option takes a name of anchestor class
  not to document inherited members of the class and uppers
* autodoc: consider a member private if docstring contains
  ``:meta private:`` in info-field-list
* autodoc: Support Annotated type (PEP-593)
* autodoc: Support singledispatch functions and methods
* autodoc: :confval:`autodoc_typehints` accepts ``"description"``
  configuration.  It shows typehints as object description
* apidoc: Propagate ``--maxdepth`` option through package documents
* glossary: emit a warning for duplicated glossary entry
* domain: Register hyperlink target for index page automatically
* std domain: emit a warning for duplicated generic objects
* py domain: Add new event: :event:`object-description-transform`
* py domain: Do not emit nitpicky warnings for built-in types
* py domain: Support lambda functions in function signature
* py domain: Allow to make a style for arguments of functions and methods
* py domain: Emit a warning on describing a python object if the
  entry is already added as the same name
* py domain: type annotations in singature are converted to cross refs
* Support priority of event handlers. For more detail, see
  :py:meth:`.Sphinx.connect()`
* Implement the scoping for :rst:dir:`productionlist` as indicated
  in the documentation.
* Support backslash line continuation in :rst:dir:`productionlist`.
* config: Allow to show an error message from conf.py via ``ConfigError``
* html: :confval:`html_scaled_image_link` will be disabled for images having
  ``no-scaled-link`` class
* Add CSS class indicating its domain for each desc node
* latex: Use babel for Chinese document when using XeLaTeX
* LaTeX: Support LaTeX Theming (experimental)
* LaTeX: Add LaTeX styling macro for :rst:role:`kbd` role
* genindex: Show "main" index entries at first
* linkcheck: writes all links to ``output.json``
* html search: full text search can be disabled for individual document
  using ``:nosearch:`` file-wide metadata
* html search: Allow to override JavaScript splitter via
  ``SearchLanguage.js_splitter_code``
* html theme: Add a theme option: ``pygments_dark_style`` to switch the
  style of code-blocks in dark mode
* The C domain has been rewritten adding for example:

  - Cross-referencing respecting the current scope.
  - Possible to document anonymous entities.
  - More specific directives and roles for each type of entitiy,
    e.g., handling scoping of enumerators.
  - New role :rst:role:`c:expr` for rendering expressions and types
    in text.

* Added ``SphinxDirective.get_source_info()``
  and ``SphinxRole.get_source_info()``.
* sphinx-build: Emit a warning if multiple files having different file
  extensions for same document found

3.0.0 final

* Added ``ObjectDescription.transform_content()``.

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

3.0.0b1

* C++, fix cross reference lookup in certain cases involving
  function overloads.
* C++, fix cross reference lookup when a directive contains multiple
  declarations.
* C++, suppress warnings for directly dependent typenames in cross references
  generated automatically in signatures.
* autodoc: Incorrect handling of nested class names on show-inheritance
* autodoc: error message for invalid directive options has wrong location
* autodoc: info-field-list is wrongly generated from type hints into the
  class description even if ``autoclass_content='class'`` set
* autodoc: a cython-function is not recognized as a function
* inheritance_diagram: Incorrect handling of nested class names
* ``code-block:: guess`` does not work
* html: source_suffix containing dot leads to wrong source link
* html: Resizing SVG image fails with ValueError
* html search: Fix use of ``html_file_suffix`` instead of
  ``html_link_suffix`` in search results
* html theme: ``bizstyle`` does not support ``sidebarwidth``
* singlehtml: Path to images broken when master doc is not in source root
* std domain: Fix whitespaces are suppressed on referring GenericObject
* console: use bright colors instead of bold
* C, parse array types.
* C, parse function pointers even in complex types.
* sphinx-build: Sphinx crashes if output directory exists as a file
* sphinx-build: Ignore bdb.BdbQuit when handling exceptions
* napoleon: Attributes and Methods sections ignore :noindex: option

3.0.0 final

* autosummary: crashed when :confval:`autosummary_generate` is False
* autosummary: raises UnboundLocalError when unknown module given
* C++, alternate operator spellings are now supported.
* C, alternate operator spellings are now supported.
* C++, comma operator in expressions, pack expansion in template
  argument lists, and more comprehensive error messages in some cases.
* C, C++, fix crash and wrong duplicate warnings related to anon symbols.
* Escape first "!" in a cross reference linking no longer possible
* py domain: The index entry generated by ``py:function`` directive is
  different with one from ``index`` directive with "builtin" type
* capital characters are not allowed for node_id
* epub: duplicated node_ids are generated
* html: a width of table was ignored on HTML builder
* Incorrect argument is passed for :event:`env-get-outdated` handlers
* autodoc: a signature of cython-function is not recognized well
* autodoc: ``__wrapped__`` functions are not documented correctly
* intersphinx: ValueError is raised when an extension sets up
  :confval:`intersphinx_mapping` on :event:`config-inited` event
* Sphinx builds has been slower since 2.4.0 on debug mode