sphinx-doc/sphinx
### [`v3.5.4`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-354-released-Apr-11-2021)
=====================================
## Dependencies
- [#9071](https://togithub.com/sphinx-doc/sphinx/issues/9071): Restrict docutils to 0.16
## Bugs fixed
- [#9078](https://togithub.com/sphinx-doc/sphinx/issues/9078): autodoc: Async staticmethods and classmethods are considered as non
async coroutine-functions with Python3.10
- [#8870](https://togithub.com/sphinx-doc/sphinx/issues/8870), [#9001](https://togithub.com/sphinx-doc/sphinx/issues/9001), [#9051](https://togithub.com/sphinx-doc/sphinx/issues/9051): html theme: The style are not applied with docutils-0.17
- toctree captions
- The content of `sidebar` directive
- figures
### [`v3.5.3`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-353-released-Mar-20-2021)
=====================================
## Features added
- [#8959](https://togithub.com/sphinx-doc/sphinx/issues/8959): using UNIX path separator in image directive confuses Sphinx on Windows
### [`v3.5.2`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-352-released-Mar-06-2021)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.5.1...v3.5.2)
=====================================
## Bugs fixed
- [#8943](https://togithub.com/sphinx-doc/sphinx/issues/8943): i18n: Crashed by broken translation messages in ES, EL and HR
- [#8936](https://togithub.com/sphinx-doc/sphinx/issues/8936): LaTeX: A custom LaTeX builder fails with unknown node error
- [#8952](https://togithub.com/sphinx-doc/sphinx/issues/8952): Exceptions raised in a Directive cause parallel builds to hang
### [`v3.5.1`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-351-released-Feb-16-2021)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.5.0...v3.5.1)
=====================================
## Bugs fixed
- [#8883](https://togithub.com/sphinx-doc/sphinx/issues/8883): autodoc: AttributeError is raised on assigning **annotations** on
read-only class
- [#8884](https://togithub.com/sphinx-doc/sphinx/issues/8884): html: minified js stemmers not included in the distributed package
- [#8885](https://togithub.com/sphinx-doc/sphinx/issues/8885): html: AttributeError is raised if CSS/JS files are installed via
:confval:`html_context`
- [#8880](https://togithub.com/sphinx-doc/sphinx/issues/8880): viewcode: ExtensionError is raised on incremental build after
unparsable python module found
### [`v3.5.0`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-350-released-Feb-14-2021)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.4.3...v3.5.0)
=====================================
## Dependencies
- LaTeX: `multicol` (it is anyhow a required part of the official latex2e
base distribution)
## Incompatible changes
- Update Underscore.js to 1.12.0
- [#6550](https://togithub.com/sphinx-doc/sphinx/issues/6550): 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
- [#8022](https://togithub.com/sphinx-doc/sphinx/issues/8022): autodoc: autodata and autoattribute directives does not show right-hand
value of the variable if docstring contains `:meta hide-value:` in
info-field-list
- [#8514](https://togithub.com/sphinx-doc/sphinx/issues/8514): autodoc: Default values of overloaded functions are taken from actual
implementation if they're ellipsis
- [#8775](https://togithub.com/sphinx-doc/sphinx/issues/8775): autodoc: Support type union operator (PEP-604) in Python 3.10 or above
- [#8297](https://togithub.com/sphinx-doc/sphinx/issues/8297): autodoc: Allow to extend :confval:`autodoc_default_options` via
directive options
- [#759](https://togithub.com/sphinx-doc/sphinx/issues/759): autodoc: Add a new configuration :confval:`autodoc_preserve_defaults` as
an experimental feature. It preserves the default argument values of
functions in source code and keep them not evaluated for readability.
- [#8619](https://togithub.com/sphinx-doc/sphinx/issues/8619): html: kbd role generates customizable HTML tags for compound keys
- [#8634](https://togithub.com/sphinx-doc/sphinx/issues/8634): html: Allow to change the order of JS/CSS via `priority` parameter
for :meth:`Sphinx.add_js_file()` and :meth:`Sphinx.add_css_file()`
- [#6241](https://togithub.com/sphinx-doc/sphinx/issues/6241): 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
- [#6550](https://togithub.com/sphinx-doc/sphinx/issues/6550): html: Allow to use HTML permalink texts via
:confval:`html_permalinks_icon`
- [#1638](https://togithub.com/sphinx-doc/sphinx/issues/1638): html: Add permalink icons to glossary terms
- [#8868](https://togithub.com/sphinx-doc/sphinx/issues/8868): html search: performance issue with massive lists
- [#8867](https://togithub.com/sphinx-doc/sphinx/issues/8867): html search: Update JavaScript stemmer code to the latest version of
Snowball (v2.1.0)
- [#8852](https://togithub.com/sphinx-doc/sphinx/issues/8852): i18n: Allow to translate heading syntax in MyST-Parser
- [#8649](https://togithub.com/sphinx-doc/sphinx/issues/8649): imgconverter: Skip availability check if builder supports the image
type
- [#8573](https://togithub.com/sphinx-doc/sphinx/issues/8573): napoleon: Allow to change the style of custom sections using
:confval:`napoleon_custom_styles`
- [#8004](https://togithub.com/sphinx-doc/sphinx/issues/8004): napoleon: Type definitions in Google style docstrings are rendered as
references when :confval:`napoleon_preprocess_types` enabled
- [#6241](https://togithub.com/sphinx-doc/sphinx/issues/6241): mathjax: Include mathjax.js only on the document using equations
- [#8775](https://togithub.com/sphinx-doc/sphinx/issues/8775): py domain: Support type union operator (PEP-604)
- [#8651](https://togithub.com/sphinx-doc/sphinx/issues/8651): std domain: cross-reference for a rubric having inline item is broken
- [#7642](https://togithub.com/sphinx-doc/sphinx/issues/7642): std domain: Optimize case-insensitive match of term
- [#8681](https://togithub.com/sphinx-doc/sphinx/issues/8681): viewcode: Support incremental build
- [#8132](https://togithub.com/sphinx-doc/sphinx/issues/8132): Add :confval:`project_copyright` as an alias of :confval:`copyright`
- [#207](https://togithub.com/sphinx-doc/sphinx/issues/207): Now :confval:`highlight_language` supports multiple languages
- [#2030](https://togithub.com/sphinx-doc/sphinx/issues/2030): :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.
- [#8247](https://togithub.com/sphinx-doc/sphinx/issues/8247): Allow production lists to refer to tokens from other production groups
- [#8813](https://togithub.com/sphinx-doc/sphinx/issues/8813): Show what extension (or module) caused it on errors on event handler
- [#8213](https://togithub.com/sphinx-doc/sphinx/issues/8213): 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
- [#8727](https://togithub.com/sphinx-doc/sphinx/issues/8727): apidoc: namespace module file is not generated if no submodules there
- [#741](https://togithub.com/sphinx-doc/sphinx/issues/741): autodoc: inherited-members doesn't work for instance attributes on super
class
- [#8592](https://togithub.com/sphinx-doc/sphinx/issues/8592): autodoc: `:meta public:` does not effect to variables
- [#8594](https://togithub.com/sphinx-doc/sphinx/issues/8594): autodoc: empty **all** attribute is ignored
- [#8315](https://togithub.com/sphinx-doc/sphinx/issues/8315): autodoc: Failed to resolve struct.Struct type annotation
- [#8652](https://togithub.com/sphinx-doc/sphinx/issues/8652): autodoc: All variable comments in the module are ignored if the module
contains invalid type comments
- [#8693](https://togithub.com/sphinx-doc/sphinx/issues/8693): autodoc: Default values for overloaded functions are rendered as string
- [#8134](https://togithub.com/sphinx-doc/sphinx/issues/8134): autodoc: crashes when mocked decorator takes arguments
- [#8800](https://togithub.com/sphinx-doc/sphinx/issues/8800): autodoc: Uninitialized attributes in superclass are recognized as
undocumented
- [#8655](https://togithub.com/sphinx-doc/sphinx/issues/8655): autodoc: Failed to generate document if target module contains an
object that raises an exception on `hasattr()`
- [#8306](https://togithub.com/sphinx-doc/sphinx/issues/8306): autosummary: mocked modules are documented as empty page when using
:recursive: option
- [#8232](https://togithub.com/sphinx-doc/sphinx/issues/8232): graphviz: Image node is not rendered if graph file is in subdirectory
- [#8618](https://togithub.com/sphinx-doc/sphinx/issues/8618): html: kbd role produces incorrect HTML when compound-key separators (-,
- or ^) are used as keystrokes
- [#8629](https://togithub.com/sphinx-doc/sphinx/issues/8629): html: A type warning for html_use_opensearch is shown twice
- [#8714](https://togithub.com/sphinx-doc/sphinx/issues/8714): html: kbd role with "Caps Lock" rendered incorrectly
- [#8123](https://togithub.com/sphinx-doc/sphinx/issues/8123): html search: fix searching for terms containing + (Requires a custom
search language that does not split on +)
- [#8665](https://togithub.com/sphinx-doc/sphinx/issues/8665): html theme: Could not override globaltoc_maxdepth in theme.conf
- [#8446](https://togithub.com/sphinx-doc/sphinx/issues/8446): html: consecutive spaces are displayed as single space
- [#8745](https://togithub.com/sphinx-doc/sphinx/issues/8745): i18n: crashes with KeyError when translation message adds a new auto
footnote reference
- [#4304](https://togithub.com/sphinx-doc/sphinx/issues/4304): linkcheck: Fix race condition that could lead to checking the
availability of the same URL twice
- [#8791](https://togithub.com/sphinx-doc/sphinx/issues/8791): linkcheck: The docname for each hyperlink is not displayed
- [#7118](https://togithub.com/sphinx-doc/sphinx/issues/7118): sphinx-quickstart: questionare got Mojibake if libreadline unavailable
- [#8094](https://togithub.com/sphinx-doc/sphinx/issues/8094): texinfo: image files on the different directory with document are not
copied
- [#8782](https://togithub.com/sphinx-doc/sphinx/issues/8782): todo: Cross references in todolist get broken
- [#8720](https://togithub.com/sphinx-doc/sphinx/issues/8720): viewcode: module pages are generated for epub on incremental build
- [#8704](https://togithub.com/sphinx-doc/sphinx/issues/8704): viewcode: anchors are generated in incremental build after singlehtml
- [#8756](https://togithub.com/sphinx-doc/sphinx/issues/8756): viewcode: highlighted code is generated even if not referenced
- [#8671](https://togithub.com/sphinx-doc/sphinx/issues/8671): :confval:`highlight_options` is not working
- [#8341](https://togithub.com/sphinx-doc/sphinx/issues/8341): C, fix intersphinx lookup types for names in declarations.
- C, C++: in general fix intersphinx and role lookup types.
- [#8683](https://togithub.com/sphinx-doc/sphinx/issues/8683): :confval:`html_last_updated_fmt` does not support UTC offset (%z)
- [#8683](https://togithub.com/sphinx-doc/sphinx/issues/8683): :confval:`html_last_updated_fmt` generates wrong time zone for %Z
- [#1112](https://togithub.com/sphinx-doc/sphinx/issues/1112): `download` role creates duplicated copies when relative path is
specified
- [#2616](https://togithub.com/sphinx-doc/sphinx/issues/2616) (fifth item): LaTeX: footnotes from captions are not clickable,
and for manually numbered footnotes only first one with same number is
an hyperlink
- [#7576](https://togithub.com/sphinx-doc/sphinx/issues/7576): LaTeX with French babel and memoir crash: "Illegal parameter number
in definition of `\FNH@prefntext`"
- [#8055](https://togithub.com/sphinx-doc/sphinx/issues/8055): LaTeX (docs): A potential display bug with the LaTeX generation step
in Sphinx (how to generate one-column index)
- [#8072](https://togithub.com/sphinx-doc/sphinx/issues/8072): LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX
- [#8214](https://togithub.com/sphinx-doc/sphinx/issues/8214): LaTeX: The :rst:role:`index` role and the glossary generate duplicate
entries in the LaTeX index (if both used for same term)
- [#8735](https://togithub.com/sphinx-doc/sphinx/issues/8735): LaTeX: wrong internal links in pdf to captioned code-blocks when
:confval:`numfig` is not True
- [#8442](https://togithub.com/sphinx-doc/sphinx/issues/8442): LaTeX: some indexed terms are ignored when using xelatex engine
(or pdflatex and :confval:`latex_use_xindy` set to True) with memoir class
- [#8750](https://togithub.com/sphinx-doc/sphinx/issues/8750): LaTeX: URLs as footnotes fail to show in PDF if originating from
inside function type signatures
- [#8780](https://togithub.com/sphinx-doc/sphinx/issues/8780): LaTeX: long words in narrow columns may not be hyphenated
- [#8788](https://togithub.com/sphinx-doc/sphinx/issues/8788): LaTeX: `\titleformat` last argument in sphinx.sty should be
bracketed, not braced (and is anyhow not needed)
- [#8849](https://togithub.com/sphinx-doc/sphinx/issues/8849): LaTex: code-block printed out of margin (see the opt-in LaTeX syntax
boolean :ref:`verbatimforcewraps ` for use via
the :ref:`'sphinxsetup' ` key of `latex_elements`)
- [#8183](https://togithub.com/sphinx-doc/sphinx/issues/8183): LaTeX: Remove substitution_reference nodes from doctree only on LaTeX
builds
- [#8865](https://togithub.com/sphinx-doc/sphinx/issues/8865): LaTeX: Restructure the index nodes inside title nodes only on LaTeX
builds
- [#8796](https://togithub.com/sphinx-doc/sphinx/issues/8796): 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.
### [`v3.4.3`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-343-released-Jan-08-2021)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.4.2...v3.4.3)
=====================================
## Bugs fixed
- [#8655](https://togithub.com/sphinx-doc/sphinx/issues/8655): autodoc: Failed to generate document if target module contains an
object that raises an exception on `hasattr()`
### [`v3.4.2`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-342-released-Jan-04-2021)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.4.1...v3.4.2)
=====================================
## Bugs fixed
- [#8164](https://togithub.com/sphinx-doc/sphinx/issues/8164): autodoc: Classes that inherit mocked class are not documented
- [#8602](https://togithub.com/sphinx-doc/sphinx/issues/8602): autodoc: The `autodoc-process-docstring` event is emitted to the
non-datadescriptors unexpectedly
- [#8616](https://togithub.com/sphinx-doc/sphinx/issues/8616): autodoc: AttributeError is raised on non-class object is passed to
autoclass directive
### [`v3.4.1`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-341-released-Dec-25-2020)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.4.0...v3.4.1)
=====================================
## Bugs fixed
- [#8559](https://togithub.com/sphinx-doc/sphinx/issues/8559): autodoc: AttributeError is raised when using forward-reference type
annotations
- [#8568](https://togithub.com/sphinx-doc/sphinx/issues/8568): autodoc: TypeError is raised on checking slots attribute
- [#8567](https://togithub.com/sphinx-doc/sphinx/issues/8567): autodoc: Instance attributes are incorrectly added to Parent class
- [#8566](https://togithub.com/sphinx-doc/sphinx/issues/8566): autodoc: The `autodoc-process-docstring` event is emitted to the
alias classes unexpectedly
- [#8583](https://togithub.com/sphinx-doc/sphinx/issues/8583): autodoc: Unnecessary object comparision via `__eq__` method
- [#8565](https://togithub.com/sphinx-doc/sphinx/issues/8565): linkcheck: Fix PriorityQueue crash when link tuples are not
comparable
### [`v3.4.0`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-340-released-Dec-20-2020)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.3.1...v3.4.0)
=====================================
## Incompatible changes
- [#8105](https://togithub.com/sphinx-doc/sphinx/issues/8105): 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
- [#8119](https://togithub.com/sphinx-doc/sphinx/issues/8119): 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
- [#8219](https://togithub.com/sphinx-doc/sphinx/issues/8219): 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.
- [#8209](https://togithub.com/sphinx-doc/sphinx/issues/8209): autodoc: Add `:no-value:` option to :rst:dir:`autoattribute` and
:rst:dir:`autodata` directive to suppress the default value of the variable
- [#8460](https://togithub.com/sphinx-doc/sphinx/issues/8460): autodoc: Support custom types defined by typing.NewType
- [#8285](https://togithub.com/sphinx-doc/sphinx/issues/8285): napoleon: Add :confval:`napoleon_attr_annotations` to merge type hints
on source code automatically if any type is specified in docstring
- [#8236](https://togithub.com/sphinx-doc/sphinx/issues/8236): napoleon: Support numpydoc's "Receives" section
- [#6914](https://togithub.com/sphinx-doc/sphinx/issues/6914): Add a new event :event:`warn-missing-reference` to custom warning
messages when failed to resolve a cross-reference
- [#6914](https://togithub.com/sphinx-doc/sphinx/issues/6914): Emit a detailed warning when failed to resolve a `:ref:` reference
- [#6629](https://togithub.com/sphinx-doc/sphinx/issues/6629): linkcheck: The builder now handles rate limits. See
:confval:`linkcheck_retry_on_rate_limit` for details.
## Bugs fixed
- [#7613](https://togithub.com/sphinx-doc/sphinx/issues/7613): autodoc: autodoc does not respect **signature** of the class
- [#4606](https://togithub.com/sphinx-doc/sphinx/issues/4606): autodoc: the location of the warning is incorrect for inherited method
- [#8105](https://togithub.com/sphinx-doc/sphinx/issues/8105): autodoc: the signature of class constructor is incorrect if the class
is decorated
- [#8434](https://togithub.com/sphinx-doc/sphinx/issues/8434): autodoc: :confval:`autodoc_type_aliases` does not effect to variables
and attributes
- [#8443](https://togithub.com/sphinx-doc/sphinx/issues/8443): autodoc: autodata directive can't create document for PEP-526 based
type annotated variables
- [#8443](https://togithub.com/sphinx-doc/sphinx/issues/8443): autodoc: autoattribute directive can't create document for PEP-526
based uninitalized variables
- [#8480](https://togithub.com/sphinx-doc/sphinx/issues/8480): autodoc: autoattribute could not create document for **slots**
attributes
- [#8503](https://togithub.com/sphinx-doc/sphinx/issues/8503): autodoc: autoattribute could not create document for a GenericAlias as
class attributes correctly
- [#8534](https://togithub.com/sphinx-doc/sphinx/issues/8534): autodoc: autoattribute could not create document for a commented
attribute in alias class
- [#8452](https://togithub.com/sphinx-doc/sphinx/issues/8452): autodoc: autodoc_type_aliases doesn't work when autodoc_typehints is
set to "description"
- [#8541](https://togithub.com/sphinx-doc/sphinx/issues/8541): autodoc: autodoc_type_aliases doesn't work for the type annotation to
instance attributes
- [#8460](https://togithub.com/sphinx-doc/sphinx/issues/8460): autodoc: autodata and autoattribute directives do not display type
information of TypeVars
- [#8493](https://togithub.com/sphinx-doc/sphinx/issues/8493): autodoc: references to builtins not working in class aliases
- [#8522](https://togithub.com/sphinx-doc/sphinx/issues/8522): autodoc: `__bool__` method could be called
- [#8067](https://togithub.com/sphinx-doc/sphinx/issues/8067): autodoc: A typehint for the instance variable having type_comment on
super class is not displayed
- [#8545](https://togithub.com/sphinx-doc/sphinx/issues/8545): autodoc: a **slots** attribute is not documented even having docstring
- [#741](https://togithub.com/sphinx-doc/sphinx/issues/741): autodoc: inherited-members doesn't work for instance attributes on super
class
- [#8477](https://togithub.com/sphinx-doc/sphinx/issues/8477): autosummary: non utf-8 reST files are generated when template contains
multibyte characters
- [#8501](https://togithub.com/sphinx-doc/sphinx/issues/8501): autosummary: summary extraction splits text after "el at." unexpectedly
- [#8524](https://togithub.com/sphinx-doc/sphinx/issues/8524): html: Wrong url_root has been generated on a document named "index"
- [#8419](https://togithub.com/sphinx-doc/sphinx/issues/8419): html search: Do not load `language_data.js` in non-search pages
- [#8549](https://togithub.com/sphinx-doc/sphinx/issues/8549): i18n: `-D gettext_compact=0` is no longer working
- [#8454](https://togithub.com/sphinx-doc/sphinx/issues/8454): graphviz: The layout option for graph and digraph directives don't work
- [#8131](https://togithub.com/sphinx-doc/sphinx/issues/8131): linkcheck: Use GET when HEAD requests cause Too Many Redirects, to
accommodate infinite redirect loops on HEAD
- [#8437](https://togithub.com/sphinx-doc/sphinx/issues/8437): Makefile: `make clean` with empty BUILDDIR is dangerous
- [#8365](https://togithub.com/sphinx-doc/sphinx/issues/8365): py domain: `:type:` and `:rtype:` gives false ambiguous class
lookup warnings
- [#8352](https://togithub.com/sphinx-doc/sphinx/issues/8352): std domain: Failed to parse an option that starts with bracket
- [#8519](https://togithub.com/sphinx-doc/sphinx/issues/8519): LaTeX: Prevent page brake in the middle of a seealso
- [#8520](https://togithub.com/sphinx-doc/sphinx/issues/8520): C, fix copying of AliasNode.
### [`v3.3.1`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-331-released-Nov-12-2020)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.3.0...v3.3.1)
=====================================
## Bugs fixed
- [#8372](https://togithub.com/sphinx-doc/sphinx/issues/8372): autodoc: autoclass directive became slower than Sphinx-3.2
- [#7727](https://togithub.com/sphinx-doc/sphinx/issues/7727): autosummary: raise PycodeError when documenting python package
without **init**.py
- [#8350](https://togithub.com/sphinx-doc/sphinx/issues/8350): autosummary: autosummary_mock_imports causes slow down builds
- [#8364](https://togithub.com/sphinx-doc/sphinx/issues/8364): C, properly initialize attributes in empty symbols.
- [#8399](https://togithub.com/sphinx-doc/sphinx/issues/8399): i18n: Put system locale path after the paths specified by configuration
### [`v3.3.0`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-330-released-Nov-02-2020)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.2.1...v3.3.0)
=====================================
## Deprecated
- `sphinx.builders.latex.LaTeXBuilder.usepackages`
- `sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref`
- `sphinx.ext.autodoc.SingledispatchFunctionDocumenter`
- `sphinx.ext.autodoc.SingledispatchMethodDocumenter`
## Features added
- [#8100](https://togithub.com/sphinx-doc/sphinx/issues/8100): html: Show a better error message for failures on copying
html_static_files
- [#8141](https://togithub.com/sphinx-doc/sphinx/issues/8141): C: added a `maxdepth` option to :rst:dir:`c:alias` to insert
nested declarations.
- [#8081](https://togithub.com/sphinx-doc/sphinx/issues/8081): LaTeX: Allow to add LaTeX package via `app.add_latex_package()` until
just before writing .tex file
- [#7996](https://togithub.com/sphinx-doc/sphinx/issues/7996): manpage: Add :confval:`man_make_section_directory` to make a section
directory on build man page
- [#8289](https://togithub.com/sphinx-doc/sphinx/issues/8289): epub: Allow to suppress "duplicated ToC entry found" warnings from epub
builder using :confval:`suppress_warnings`.
- [#8298](https://togithub.com/sphinx-doc/sphinx/issues/8298): sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep` option
- [#8304](https://togithub.com/sphinx-doc/sphinx/issues/8304): sphinx.testing: Register public markers in sphinx.testing.fixtures
- [#8051](https://togithub.com/sphinx-doc/sphinx/issues/8051): napoleon: use the obj role for all See Also items
- [#8050](https://togithub.com/sphinx-doc/sphinx/issues/8050): napoleon: Apply :confval:`napoleon_preprocess_types` to every field
- C and C++, show line numbers for previous declarations when duplicates are
detected.
- [#8183](https://togithub.com/sphinx-doc/sphinx/issues/8183): Remove substitution_reference nodes from doctree only on LaTeX builds
## Bugs fixed
- [#8085](https://togithub.com/sphinx-doc/sphinx/issues/8085): i18n: Add support for having single text domain
- [#6640](https://togithub.com/sphinx-doc/sphinx/issues/6640): i18n: Failed to override system message translation
- [#8143](https://togithub.com/sphinx-doc/sphinx/issues/8143): autodoc: AttributeError is raised when False value is passed to
autodoc_default_options
- [#8103](https://togithub.com/sphinx-doc/sphinx/issues/8103): autodoc: functools.cached_property is not considered as a property
- [#8190](https://togithub.com/sphinx-doc/sphinx/issues/8190): autodoc: parsing error is raised if some extension replaces docstring
by string not ending with blank lines
- [#8142](https://togithub.com/sphinx-doc/sphinx/issues/8142): autodoc: Wrong constructor signature for the class derived from
typing.Generic
- [#8157](https://togithub.com/sphinx-doc/sphinx/issues/8157): autodoc: TypeError is raised when annotation has invalid **args**
- [#7964](https://togithub.com/sphinx-doc/sphinx/issues/7964): autodoc: Tuple in default value is wrongly rendered
- [#8200](https://togithub.com/sphinx-doc/sphinx/issues/8200): autodoc: type aliases break type formatting of autoattribute
- [#7786](https://togithub.com/sphinx-doc/sphinx/issues/7786): autodoc: can't detect overloaded methods defined in other file
- [#8294](https://togithub.com/sphinx-doc/sphinx/issues/8294): autodoc: single-string **slots** is not handled correctly
- [#7785](https://togithub.com/sphinx-doc/sphinx/issues/7785): autodoc: autodoc_typehints='none' does not effect to overloaded functions
- [#8192](https://togithub.com/sphinx-doc/sphinx/issues/8192): napoleon: description is disappeared when it contains inline literals
- [#8142](https://togithub.com/sphinx-doc/sphinx/issues/8142): napoleon: Potential of regex denial of service in google style docs
- [#8169](https://togithub.com/sphinx-doc/sphinx/issues/8169): LaTeX: pxjahyper loaded even when latex_engine is not platex
- [#8215](https://togithub.com/sphinx-doc/sphinx/issues/8215): LaTeX: 'oneside' classoption causes build warning
- [#8175](https://togithub.com/sphinx-doc/sphinx/issues/8175): intersphinx: Potential of regex denial of service by broken inventory
- [#8277](https://togithub.com/sphinx-doc/sphinx/issues/8277): sphinx-build: missing and redundant spacing (and etc) for console
output on building
- [#7973](https://togithub.com/sphinx-doc/sphinx/issues/7973): imgconverter: Check availability of imagemagick many times
- [#8255](https://togithub.com/sphinx-doc/sphinx/issues/8255): py domain: number in default argument value is changed from hexadecimal
to decimal
- [#8316](https://togithub.com/sphinx-doc/sphinx/issues/8316): html: Prevent arrow keys changing page when button elements are focused
- [#8343](https://togithub.com/sphinx-doc/sphinx/issues/8343): html search: Fix unnecessary load of images when parsing the document
- [#8254](https://togithub.com/sphinx-doc/sphinx/issues/8254): html theme: Line numbers misalign with code lines
- [#8093](https://togithub.com/sphinx-doc/sphinx/issues/8093): The highlight warning has wrong location in some builders (LaTeX,
singlehtml and so on)
- [#8215](https://togithub.com/sphinx-doc/sphinx/issues/8215): Eliminate Fancyhdr build warnings for oneside documents
- [#8239](https://togithub.com/sphinx-doc/sphinx/issues/8239): Failed to refer a token in productionlist if it is indented
- [#8268](https://togithub.com/sphinx-doc/sphinx/issues/8268): linkcheck: Report HTTP errors when `linkcheck_anchors` is `True`
- [#8245](https://togithub.com/sphinx-doc/sphinx/issues/8245): linkcheck: take source directory into account for local files
- [#8321](https://togithub.com/sphinx-doc/sphinx/issues/8321): linkcheck: `tel:` schema hyperlinks are detected as errors
- [#8323](https://togithub.com/sphinx-doc/sphinx/issues/8323): linkcheck: An exit status is incorrect when links having unsupported
schema found
- [#8188](https://togithub.com/sphinx-doc/sphinx/issues/8188): C, add missing items to internal object types dictionary,
e.g., preventing intersphinx from resolving them.
- C, fix anon objects in intersphinx.
- [#8270](https://togithub.com/sphinx-doc/sphinx/issues/8270), 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.
- [#6914](https://togithub.com/sphinx-doc/sphinx/issues/6914): figure numbers are unexpectedly assigned to uncaptioned items
- [#8320](https://togithub.com/sphinx-doc/sphinx/issues/8320): make "inline" line numbers un-selectable
## Testing
- [#8257](https://togithub.com/sphinx-doc/sphinx/issues/8257): Support parallel build in sphinx.testing
### [`v3.2.1`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-321-released-Aug-14-2020)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.2.0...v3.2.1)
=====================================
## Features added
- [#8095](https://togithub.com/sphinx-doc/sphinx/issues/8095): napoleon: Add :confval:`napoleon_preprocess_types` to enable the type
preprocessor for numpy style docstrings
- [#8114](https://togithub.com/sphinx-doc/sphinx/issues/8114): C and C++, parse function attributes after parameters and qualifiers.
## Bugs fixed
- [#8074](https://togithub.com/sphinx-doc/sphinx/issues/8074): napoleon: Crashes during processing C-ext module
- [#8088](https://togithub.com/sphinx-doc/sphinx/issues/8088): napoleon: "Inline literal start-string without end-string" warning in
Numpy style Parameters section
- [#8084](https://togithub.com/sphinx-doc/sphinx/issues/8084): autodoc: KeyError is raised on documenting an attribute of the broken
class
- [#8091](https://togithub.com/sphinx-doc/sphinx/issues/8091): autodoc: AttributeError is raised on documenting an attribute on Python
3.5.2
- [#8099](https://togithub.com/sphinx-doc/sphinx/issues/8099): autodoc: NameError is raised when target code uses `TYPE_CHECKING`
- C++, fix parsing of template template paramters, broken by the fix of [#7944](https://togithub.com/sphinx-doc/sphinx/issues/7944)
### [`v3.2.0`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-320-released-Aug-08-2020)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.1.2...v3.2.0)
=====================================
## 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
- [#2076](https://togithub.com/sphinx-doc/sphinx/issues/2076): autodoc: Allow overriding of exclude-members in skip-member function
- [#8034](https://togithub.com/sphinx-doc/sphinx/issues/8034): autodoc: `:private-member:` can take an explicit list of member names
to be documented
- [#2024](https://togithub.com/sphinx-doc/sphinx/issues/2024): autosummary: Add :confval:`autosummary_filename_map` to avoid conflict
of filenames between two object with different case
- [#8011](https://togithub.com/sphinx-doc/sphinx/issues/8011): autosummary: Support instance attributes as a target of autosummary
directive
- [#7849](https://togithub.com/sphinx-doc/sphinx/issues/7849): html: Add :confval:`html_codeblock_linenos_style` to change the style
of line numbers for code-blocks
- [#7853](https://togithub.com/sphinx-doc/sphinx/issues/7853): C and C++, support parameterized GNU style attributes.
- [#7888](https://togithub.com/sphinx-doc/sphinx/issues/7888): napoleon: Add aliases Warn and Raise.
- [#7690](https://togithub.com/sphinx-doc/sphinx/issues/7690): napoleon: parse type strings and make them hyperlinks as possible. The
conversion rule can be updated via :confval:`napoleon_type_aliases`
- [#8049](https://togithub.com/sphinx-doc/sphinx/issues/8049): 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.
- [#7745](https://togithub.com/sphinx-doc/sphinx/issues/7745): html: inventory is broken if the docname contains a space
- [#7991](https://togithub.com/sphinx-doc/sphinx/issues/7991): html search: Allow searching for numbers
- [#7902](https://togithub.com/sphinx-doc/sphinx/issues/7902): html theme: Add a new option :confval:`globaltoc_maxdepth` to control
the behavior of globaltoc in sidebar
- [#7840](https://togithub.com/sphinx-doc/sphinx/issues/7840): i18n: Optimize the dependencies check on bootstrap
- [#7768](https://togithub.com/sphinx-doc/sphinx/issues/7768): i18n: :confval:`figure_language_filename` supports `docpath` token
- [#5208](https://togithub.com/sphinx-doc/sphinx/issues/5208): linkcheck: Support checks for local links
- [#5090](https://togithub.com/sphinx-doc/sphinx/issues/5090): setuptools: Link verbosity to distutils' -v and -q option
- [#6698](https://togithub.com/sphinx-doc/sphinx/issues/6698): doctest: Add `:trim-doctest-flags:` and `:no-trim-doctest-flags:`
options to doctest, testcode and testoutput directives
- [#7052](https://togithub.com/sphinx-doc/sphinx/issues/7052): 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.
- [#7899](https://togithub.com/sphinx-doc/sphinx/issues/7899): 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.
- [#7999](https://togithub.com/sphinx-doc/sphinx/issues/7999): C, add support for named variadic macro arguments.
- [#8071](https://togithub.com/sphinx-doc/sphinx/issues/8071): Allow to suppress "self referenced toctrees" warning
## Bugs fixed
- [#7886](https://togithub.com/sphinx-doc/sphinx/issues/7886): autodoc: TypeError is raised on mocking generic-typed classes
- [#7935](https://togithub.com/sphinx-doc/sphinx/issues/7935): autodoc: function signature is not shown when the function has a
parameter having `inspect._empty` as its default value
- [#7901](https://togithub.com/sphinx-doc/sphinx/issues/7901): autodoc: type annotations for overloaded functions are not resolved
- [#904](https://togithub.com/sphinx-doc/sphinx/issues/904): autodoc: An instance attribute cause a crash of autofunction directive
- [#1362](https://togithub.com/sphinx-doc/sphinx/issues/1362): autodoc: `private-members` option does not work for class attributes
- [#7983](https://togithub.com/sphinx-doc/sphinx/issues/7983): autodoc: Generator type annotation is wrongly rendered in py36
- [#8030](https://togithub.com/sphinx-doc/sphinx/issues/8030): autodoc: An uninitialized annotated instance variable is not documented
when `:inherited-members:` option given
- [#8032](https://togithub.com/sphinx-doc/sphinx/issues/8032): autodoc: A type hint for the instance variable defined at parent class
is not shown in the document of the derived class
- [#8041](https://togithub.com/sphinx-doc/sphinx/issues/8041): autodoc: An annotated instance variable on super class is not
documented when derived class has other annotated instance variables
- [#7839](https://togithub.com/sphinx-doc/sphinx/issues/7839): autosummary: cannot handle umlauts in function names
- [#7865](https://togithub.com/sphinx-doc/sphinx/issues/7865): autosummary: Failed to extract summary line when abbreviations found
- [#7866](https://togithub.com/sphinx-doc/sphinx/issues/7866): autosummary: Failed to extract correct summary line when docstring
contains a hyperlink target
- [#7469](https://togithub.com/sphinx-doc/sphinx/issues/7469): autosummary: "Module attributes" header is not translatable
- [#7940](https://togithub.com/sphinx-doc/sphinx/issues/7940): apidoc: An extra newline is generated at the end of the rst file if a
module has submodules
- [#4258](https://togithub.com/sphinx-doc/sphinx/issues/4258): napoleon: decorated special methods are not shown
- [#7799](https://togithub.com/sphinx-doc/sphinx/issues/7799): napoleon: parameters are not escaped for combined params in numpydoc
- [#7780](https://togithub.com/sphinx-doc/sphinx/issues/7780): napoleon: multiple paramaters declaration in numpydoc was wrongly
recognized when napoleon_use_params=True
- [#7715](https://togithub.com/sphinx-doc/sphinx/issues/7715): LaTeX: `numfig_secnum_depth > 1` leads to wrong figure links
- [#7846](https://togithub.com/sphinx-doc/sphinx/issues/7846): html theme: XML-invalid files were generated
- [#7894](https://togithub.com/sphinx-doc/sphinx/issues/7894): gettext: Wrong source info is shown when using rst_epilog
- [#7691](https://togithub.com/sphinx-doc/sphinx/issues/7691): linkcheck: HEAD requests are not used for checking
- [#4888](https://togithub.com/sphinx-doc/sphinx/issues/4888): i18n: Failed to add an explicit title to `:ref:` role on translation
- [#7928](https://togithub.com/sphinx-doc/sphinx/issues/7928): py domain: failed to resolve a type annotation for the attribute
- [#8008](https://togithub.com/sphinx-doc/sphinx/issues/8008): py domain: failed to parse a type annotation containing ellipsis
- [#7994](https://togithub.com/sphinx-doc/sphinx/issues/7994): std domain: option directive does not generate old node_id compatible
with 2.x or older
- [#7968](https://togithub.com/sphinx-doc/sphinx/issues/7968): i18n: The content of `math` directive is interpreted as reST on
translation
- [#7768](https://togithub.com/sphinx-doc/sphinx/issues/7768): i18n: The `root` element for :confval:`figure_language_filename` is
not a path that user specifies in the document
- [#7993](https://togithub.com/sphinx-doc/sphinx/issues/7993): texinfo: TypeError is raised for nested object descriptions
- [#7993](https://togithub.com/sphinx-doc/sphinx/issues/7993): texinfo: a warning not supporting desc_signature_line node is shown
- [#7869](https://togithub.com/sphinx-doc/sphinx/issues/7869): :rst:role:`abbr` role without an explanation will show the explanation
from the previous abbr role
- [#8048](https://togithub.com/sphinx-doc/sphinx/issues/8048): graphviz: graphviz.css was copied on building non-HTML document
- C and C++, removed `noindex` directive option as it did
nothing.
- [#7619](https://togithub.com/sphinx-doc/sphinx/issues/7619): Duplicated node IDs are generated if node has multiple IDs
- [#2050](https://togithub.com/sphinx-doc/sphinx/issues/2050): Symbols sections are appeared twice in the index page
- [#8017](https://togithub.com/sphinx-doc/sphinx/issues/8017): Fix circular import in sphinx.addnodes
- [#7986](https://togithub.com/sphinx-doc/sphinx/issues/7986): CSS: make "highlight" selector more robust
- [#7944](https://togithub.com/sphinx-doc/sphinx/issues/7944): 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.
### [`v3.1.2`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-312-released-Jul-05-2020)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.1.1...v3.1.2)
=====================================
## Incompatible changes
- [#7650](https://togithub.com/sphinx-doc/sphinx/issues/7650): autodoc: the signature of base function will be shown for decorated
functions, not a signature of decorator
## Bugs fixed
- [#7844](https://togithub.com/sphinx-doc/sphinx/issues/7844): autodoc: Failed to detect module when relative module name given
- [#7856](https://togithub.com/sphinx-doc/sphinx/issues/7856): autodoc: AttributeError is raised when non-class object is given to
the autoclass directive
- [#7850](https://togithub.com/sphinx-doc/sphinx/issues/7850): autodoc: KeyError is raised for invalid mark up when autodoc_typehints
is 'description'
- [#7812](https://togithub.com/sphinx-doc/sphinx/issues/7812): autodoc: crashed if the target name matches to both an attribute and
module that are same name
- [#7650](https://togithub.com/sphinx-doc/sphinx/issues/7650): autodoc: function signature becomes `(*args, **kwargs)` if the
function is decorated by generic decorator
- [#7812](https://togithub.com/sphinx-doc/sphinx/issues/7812): autosummary: generates broken stub files if the target code contains
an attribute and module that are same name
- [#7806](https://togithub.com/sphinx-doc/sphinx/issues/7806): viewcode: Failed to resolve viewcode references on 3rd party builders
- [#7838](https://togithub.com/sphinx-doc/sphinx/issues/7838): html theme: List items have extra vertical space
- [#7878](https://togithub.com/sphinx-doc/sphinx/issues/7878): html theme: Undesired interaction between "overflow" and "float"
### [`v3.1.1`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-311-released-Jun-14-2020)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.1.0...v3.1.1)
=====================================
## Incompatible changes
- [#7808](https://togithub.com/sphinx-doc/sphinx/issues/7808): napoleon: a type for attribute are represented as typed field
## Features added
- [#7807](https://togithub.com/sphinx-doc/sphinx/issues/7807): autodoc: Show detailed warning when type_comment is mismatched with its
signature
## Bugs fixed
- [#7808](https://togithub.com/sphinx-doc/sphinx/issues/7808): autodoc: Warnings raised on variable and attribute type annotations
- [#7802](https://togithub.com/sphinx-doc/sphinx/issues/7802): autodoc: EOFError is raised on parallel build
- [#7821](https://togithub.com/sphinx-doc/sphinx/issues/7821): autodoc: TypeError is raised for overloaded C-ext function
- [#7805](https://togithub.com/sphinx-doc/sphinx/issues/7805): autodoc: an object which descriptors returns is unexpectedly documented
- [#7807](https://togithub.com/sphinx-doc/sphinx/issues/7807): autodoc: wrong signature is shown for the function using contextmanager
- [#7812](https://togithub.com/sphinx-doc/sphinx/issues/7812): autosummary: generates broken stub files if the target code contains
an attribute and module that are same name
- [#7808](https://togithub.com/sphinx-doc/sphinx/issues/7808): napoleon: Warnings raised on variable and attribute type annotations
- [#7811](https://togithub.com/sphinx-doc/sphinx/issues/7811): sphinx.util.inspect causes circular import problem
### [`v3.1.0`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-310-released-Jun-08-2020)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.0.4...v3.1.0)
=====================================
## Dependencies
- [#7746](https://togithub.com/sphinx-doc/sphinx/issues/7746): mathjax: Update to 2.7.5
## Incompatible changes
- [#7477](https://togithub.com/sphinx-doc/sphinx/issues/7477): 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
- [#7410](https://togithub.com/sphinx-doc/sphinx/issues/7410): 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`.
- [#2044](https://togithub.com/sphinx-doc/sphinx/issues/2044): autodoc: Suppress default value for instance attributes
- [#7473](https://togithub.com/sphinx-doc/sphinx/issues/7473): autodoc: consider a member public if docstring contains
`:meta public:` in info-field-list
- [#7487](https://togithub.com/sphinx-doc/sphinx/issues/7487): autodoc: Allow to generate docs for singledispatch functions by
py:autofunction
- [#7143](https://togithub.com/sphinx-doc/sphinx/issues/7143): autodoc: Support final classes and methods
- [#7384](https://togithub.com/sphinx-doc/sphinx/issues/7384): autodoc: Support signatures defined by `__new__()`, metaclasses and
builtin base classes
- [#2106](https://togithub.com/sphinx-doc/sphinx/issues/2106): autodoc: Support multiple signatures on docstring
- [#4422](https://togithub.com/sphinx-doc/sphinx/issues/4422): autodoc: Support GenericAlias in Python 3.7 or above
- [#3610](https://togithub.com/sphinx-doc/sphinx/issues/3610): autodoc: Support overloaded functions
- [#7722](https://togithub.com/sphinx-doc/sphinx/issues/7722): autodoc: Support TypeVar
- [#7466](https://togithub.com/sphinx-doc/sphinx/issues/7466): autosummary: headings in generated documents are not translated
- [#7490](https://togithub.com/sphinx-doc/sphinx/issues/7490): autosummary: Add `:caption:` option to autosummary directive to set a
caption to the toctree
- [#7469](https://togithub.com/sphinx-doc/sphinx/issues/7469): autosummary: Support module attributes
- [#248](https://togithub.com/sphinx-doc/sphinx/issues/248), [#6040](https://togithub.com/sphinx-doc/sphinx/issues/6040): autosummary: Add `:recursive:` option to autosummary directive
to generate stub files recursively
- [#4030](https://togithub.com/sphinx-doc/sphinx/issues/4030): autosummary: Add :confval:`autosummary_context` to add template
variables for custom templates
- [#7530](https://togithub.com/sphinx-doc/sphinx/issues/7530): html: Support nested elements
- [#7481](https://togithub.com/sphinx-doc/sphinx/issues/7481): html theme: Add right margin to footnote/citation labels
- [#7482](https://togithub.com/sphinx-doc/sphinx/issues/7482), [#7717](https://togithub.com/sphinx-doc/sphinx/issues/7717): html theme: CSS spacing for code blocks with captions and line
numbers
- [#7443](https://togithub.com/sphinx-doc/sphinx/issues/7443): html theme: Add new options :confval:`globaltoc_collapse` and
:confval:`globaltoc_includehidden` to control the behavior of globaltoc in
sidebar
- [#7484](https://togithub.com/sphinx-doc/sphinx/issues/7484): html theme: Avoid clashes between sidebar and other blocks
- [#7476](https://togithub.com/sphinx-doc/sphinx/issues/7476): html theme: Relbar breadcrumb should contain current page
- [#7506](https://togithub.com/sphinx-doc/sphinx/issues/7506): html theme: A canonical URL is not escaped
- [#7533](https://togithub.com/sphinx-doc/sphinx/issues/7533): html theme: Avoid whitespace at the beginning of genindex.html
- [#7541](https://togithub.com/sphinx-doc/sphinx/issues/7541): html theme: Add a "clearer" at the end of the "body"
- [#7542](https://togithub.com/sphinx-doc/sphinx/issues/7542): html theme: Make admonition/topic/sidebar scrollable
- [#7543](https://togithub.com/sphinx-doc/sphinx/issues/7543): html theme: Add top and bottom margins to tables
- [#7695](https://togithub.com/sphinx-doc/sphinx/issues/7695): html theme: Add viewport meta tag for basic theme
- [#7721](https://togithub.com/sphinx-doc/sphinx/issues/7721): 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.
- [#7294](https://togithub.com/sphinx-doc/sphinx/issues/7294): C++, parse expressions with user-defined literals.
- C++, parse trailing return types.
- [#7143](https://togithub.com/sphinx-doc/sphinx/issues/7143): py domain: Add `:final:` option to :rst:dir:`py:class:`,
:rst:dir:`py:exception:` and :rst:dir:`py:method:` directives
- [#7596](https://togithub.com/sphinx-doc/sphinx/issues/7596): py domain: Change a type annotation for variables to a hyperlink
- [#7770](https://togithub.com/sphinx-doc/sphinx/issues/7770): std domain: :rst:dir:`option` directive support arguments in the form
of `foo[=bar]`
- [#7582](https://togithub.com/sphinx-doc/sphinx/issues/7582): napoleon: a type for attribute are represented like type annotation
- [#7734](https://togithub.com/sphinx-doc/sphinx/issues/7734): napoleon: overescaped trailing underscore on attribute
- [#7247](https://togithub.com/sphinx-doc/sphinx/issues/7247): linkcheck: Add :confval:`linkcheck_request_headers` to send custom HTTP
headers for specific host
- [#7792](https://togithub.com/sphinx-doc/sphinx/issues/7792): setuptools: Support `--verbosity` option
- [#7683](https://togithub.com/sphinx-doc/sphinx/issues/7683): Add `allowed_exceptions` parameter to `Sphinx.emit()` to allow
handlers to raise specified exceptions
- [#7295](https://togithub.com/sphinx-doc/sphinx/issues/7295): C++, parse (trailing) requires clauses.
## Bugs fixed
- [#6703](https://togithub.com/sphinx-doc/sphinx/issues/6703): autodoc: incremental build does not work for imported objects
- [#7564](https://togithub.com/sphinx-doc/sphinx/issues/7564): autodoc: annotations not to be shown for descriptors
- [#6588](https://togithub.com/sphinx-doc/sphinx/issues/6588): autodoc: Decorated inherited method has no documentation
- [#7469](https://togithub.com/sphinx-doc/sphinx/issues/7469): autodoc: The change of autodoc-process-docstring for variables is
cached unexpectedly
- [#7559](https://togithub.com/sphinx-doc/sphinx/issues/7559): autodoc: misdetects a sync function is async
- [#6857](https://togithub.com/sphinx-doc/sphinx/issues/6857): autodoc: failed to detect a classmethod on Enum class
- [#7562](https://togithub.com/sphinx-doc/sphinx/issues/7562): autodoc: a typehint contains spaces is wrongly rendered under
autodoc_typehints='description' mode
- [#7551](https://togithub.com/sphinx-doc/sphinx/issues/7551): autodoc: failed to import nested class
- [#7362](https://togithub.com/sphinx-doc/sphinx/issues/7362): autodoc: does not render correct signatures for built-in functions
- [#7654](https://togithub.com/sphinx-doc/sphinx/issues/7654): autodoc: `Optional[Union[foo, bar]]` is presented as
`Union[foo, bar, None]`
- [#7629](https://togithub.com/sphinx-doc/sphinx/issues/7629): autodoc: autofunction emits an unfriendly warning if an invalid object
specified
- [#7650](https://togithub.com/sphinx-doc/sphinx/issues/7650): autodoc: undecorated signature is shown for decorated functions
- [#7676](https://togithub.com/sphinx-doc/sphinx/issues/7676): autodoc: typo in the default value of autodoc_member_order
- [#7676](https://togithub.com/sphinx-doc/sphinx/issues/7676): autodoc: wrong value for :member-order: option is ignored silently
Configuration
:date: Schedule: At any time (no schedule defined).
:vertical_traffic_light: Automerge: Disabled by config. Please merge this manually once you are satisfied.
:recycle: Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
:no_bell: Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box.
This PR contains the following updates:
==1.7.1->==3.5.4Release Notes
sphinx-doc/sphinx
### [`v3.5.4`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-354-released-Apr-11-2021) ===================================== ## Dependencies - [#9071](https://togithub.com/sphinx-doc/sphinx/issues/9071): Restrict docutils to 0.16 ## Bugs fixed - [#9078](https://togithub.com/sphinx-doc/sphinx/issues/9078): autodoc: Async staticmethods and classmethods are considered as non async coroutine-functions with Python3.10 - [#8870](https://togithub.com/sphinx-doc/sphinx/issues/8870), [#9001](https://togithub.com/sphinx-doc/sphinx/issues/9001), [#9051](https://togithub.com/sphinx-doc/sphinx/issues/9051): html theme: The style are not applied with docutils-0.17 - toctree captions - The content of `sidebar` directive - figures ### [`v3.5.3`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-353-released-Mar-20-2021) ===================================== ## Features added - [#8959](https://togithub.com/sphinx-doc/sphinx/issues/8959): using UNIX path separator in image directive confuses Sphinx on Windows ### [`v3.5.2`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-352-released-Mar-06-2021) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.5.1...v3.5.2) ===================================== ## Bugs fixed - [#8943](https://togithub.com/sphinx-doc/sphinx/issues/8943): i18n: Crashed by broken translation messages in ES, EL and HR - [#8936](https://togithub.com/sphinx-doc/sphinx/issues/8936): LaTeX: A custom LaTeX builder fails with unknown node error - [#8952](https://togithub.com/sphinx-doc/sphinx/issues/8952): Exceptions raised in a Directive cause parallel builds to hang ### [`v3.5.1`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-351-released-Feb-16-2021) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.5.0...v3.5.1) ===================================== ## Bugs fixed - [#8883](https://togithub.com/sphinx-doc/sphinx/issues/8883): autodoc: AttributeError is raised on assigning **annotations** on read-only class - [#8884](https://togithub.com/sphinx-doc/sphinx/issues/8884): html: minified js stemmers not included in the distributed package - [#8885](https://togithub.com/sphinx-doc/sphinx/issues/8885): html: AttributeError is raised if CSS/JS files are installed via :confval:`html_context` - [#8880](https://togithub.com/sphinx-doc/sphinx/issues/8880): viewcode: ExtensionError is raised on incremental build after unparsable python module found ### [`v3.5.0`](https://togithub.com/sphinx-doc/sphinx/blob/master/CHANGES#Release-350-released-Feb-14-2021) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v3.4.3...v3.5.0) ===================================== ## Dependencies - LaTeX: `multicol` (it is anyhow a required part of the official latex2e base distribution) ## Incompatible changes - Update Underscore.js to 1.12.0 - [#6550](https://togithub.com/sphinx-doc/sphinx/issues/6550): 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 - [#8022](https://togithub.com/sphinx-doc/sphinx/issues/8022): autodoc: autodata and autoattribute directives does not show right-hand value of the variable if docstring contains `:meta hide-value:` in info-field-list - [#8514](https://togithub.com/sphinx-doc/sphinx/issues/8514): autodoc: Default values of overloaded functions are taken from actual implementation if they're ellipsis - [#8775](https://togithub.com/sphinx-doc/sphinx/issues/8775): autodoc: Support type union operator (PEP-604) in Python 3.10 or above - [#8297](https://togithub.com/sphinx-doc/sphinx/issues/8297): autodoc: Allow to extend :confval:`autodoc_default_options` via directive options - [#759](https://togithub.com/sphinx-doc/sphinx/issues/759): autodoc: Add a new configuration :confval:`autodoc_preserve_defaults` as an experimental feature. It preserves the default argument values of functions in source code and keep them not evaluated for readability. - [#8619](https://togithub.com/sphinx-doc/sphinx/issues/8619): html: kbd role generates customizable HTML tags for compound keys - [#8634](https://togithub.com/sphinx-doc/sphinx/issues/8634): html: Allow to change the order of JS/CSS via `priority` parameter for :meth:`Sphinx.add_js_file()` and :meth:`Sphinx.add_css_file()` - [#6241](https://togithub.com/sphinx-doc/sphinx/issues/6241): 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 - [#6550](https://togithub.com/sphinx-doc/sphinx/issues/6550): html: Allow to use HTML permalink texts via :confval:`html_permalinks_icon` - [#1638](https://togithub.com/sphinx-doc/sphinx/issues/1638): html: Add permalink icons to glossary terms - [#8868](https://togithub.com/sphinx-doc/sphinx/issues/8868): html search: performance issue with massive lists - [#8867](https://togithub.com/sphinx-doc/sphinx/issues/8867): html search: Update JavaScript stemmer code to the latest version of Snowball (v2.1.0) - [#8852](https://togithub.com/sphinx-doc/sphinx/issues/8852): i18n: Allow to translate heading syntax in MyST-Parser - [#8649](https://togithub.com/sphinx-doc/sphinx/issues/8649): imgconverter: Skip availability check if builder supports the image type - [#8573](https://togithub.com/sphinx-doc/sphinx/issues/8573): napoleon: Allow to change the style of custom sections using :confval:`napoleon_custom_styles` - [#8004](https://togithub.com/sphinx-doc/sphinx/issues/8004): napoleon: Type definitions in Google style docstrings are rendered as references when :confval:`napoleon_preprocess_types` enabled - [#6241](https://togithub.com/sphinx-doc/sphinx/issues/6241): mathjax: Include mathjax.js only on the document using equations - [#8775](https://togithub.com/sphinx-doc/sphinx/issues/8775): py domain: Support type union operator (PEP-604) - [#8651](https://togithub.com/sphinx-doc/sphinx/issues/8651): std domain: cross-reference for a rubric having inline item is broken - [#7642](https://togithub.com/sphinx-doc/sphinx/issues/7642): std domain: Optimize case-insensitive match of term - [#8681](https://togithub.com/sphinx-doc/sphinx/issues/8681): viewcode: Support incremental build - [#8132](https://togithub.com/sphinx-doc/sphinx/issues/8132): Add :confval:`project_copyright` as an alias of :confval:`copyright` - [#207](https://togithub.com/sphinx-doc/sphinx/issues/207): Now :confval:`highlight_language` supports multiple languages - [#2030](https://togithub.com/sphinx-doc/sphinx/issues/2030): :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. - [#8247](https://togithub.com/sphinx-doc/sphinx/issues/8247): Allow production lists to refer to tokens from other production groups - [#8813](https://togithub.com/sphinx-doc/sphinx/issues/8813): Show what extension (or module) caused it on errors on event handler - [#8213](https://togithub.com/sphinx-doc/sphinx/issues/8213): 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 - [#8727](https://togithub.com/sphinx-doc/sphinx/issues/8727): apidoc: namespace module file is not generated if no submodules there - [#741](https://togithub.com/sphinx-doc/sphinx/issues/741): autodoc: inherited-members doesn't work for instance attributes on super class - [#8592](https://togithub.com/sphinx-doc/sphinx/issues/8592): autodoc: `:meta public:` does not effect to variables - [#8594](https://togithub.com/sphinx-doc/sphinx/issues/8594): autodoc: empty **all** attribute is ignored - [#8315](https://togithub.com/sphinx-doc/sphinx/issues/8315): autodoc: Failed to resolve struct.Struct type annotation - [#8652](https://togithub.com/sphinx-doc/sphinx/issues/8652): autodoc: All variable comments in the module are ignored if the module contains invalid type comments - [#8693](https://togithub.com/sphinx-doc/sphinx/issues/8693): autodoc: Default values for overloaded functions are rendered as string - [#8134](https://togithub.com/sphinx-doc/sphinx/issues/8134): autodoc: crashes when mocked decorator takes arguments - [#8800](https://togithub.com/sphinx-doc/sphinx/issues/8800): autodoc: Uninitialized attributes in superclass are recognized as undocumented - [#8655](https://togithub.com/sphinx-doc/sphinx/issues/8655): autodoc: Failed to generate document if target module contains an object that raises an exception on `hasattr()` - [#8306](https://togithub.com/sphinx-doc/sphinx/issues/8306): autosummary: mocked modules are documented as empty page when using :recursive: option - [#8232](https://togithub.com/sphinx-doc/sphinx/issues/8232): graphviz: Image node is not rendered if graph file is in subdirectory - [#8618](https://togithub.com/sphinx-doc/sphinx/issues/8618): html: kbd role produces incorrect HTML when compound-key separators (-, - or ^) are used as keystrokes - [#8629](https://togithub.com/sphinx-doc/sphinx/issues/8629): html: A type warning for html_use_opensearch is shown twice - [#8714](https://togithub.com/sphinx-doc/sphinx/issues/8714): html: kbd role with "Caps Lock" rendered incorrectly - [#8123](https://togithub.com/sphinx-doc/sphinx/issues/8123): html search: fix searching for terms containing + (Requires a custom search language that does not split on +) - [#8665](https://togithub.com/sphinx-doc/sphinx/issues/8665): html theme: Could not override globaltoc_maxdepth in theme.conf - [#8446](https://togithub.com/sphinx-doc/sphinx/issues/8446): html: consecutive spaces are displayed as single space - [#8745](https://togithub.com/sphinx-doc/sphinx/issues/8745): i18n: crashes with KeyError when translation message adds a new auto footnote reference - [#4304](https://togithub.com/sphinx-doc/sphinx/issues/4304): linkcheck: Fix race condition that could lead to checking the availability of the same URL twice - [#8791](https://togithub.com/sphinx-doc/sphinx/issues/8791): linkcheck: The docname for each hyperlink is not displayed - [#7118](https://togithub.com/sphinx-doc/sphinx/issues/7118): sphinx-quickstart: questionare got Mojibake if libreadline unavailable - [#8094](https://togithub.com/sphinx-doc/sphinx/issues/8094): texinfo: image files on the different directory with document are not copied - [#8782](https://togithub.com/sphinx-doc/sphinx/issues/8782): todo: Cross references in todolist get broken - [#8720](https://togithub.com/sphinx-doc/sphinx/issues/8720): viewcode: module pages are generated for epub on incremental build - [#8704](https://togithub.com/sphinx-doc/sphinx/issues/8704): viewcode: anchors are generated in incremental build after singlehtml - [#8756](https://togithub.com/sphinx-doc/sphinx/issues/8756): viewcode: highlighted code is generated even if not referenced - [#8671](https://togithub.com/sphinx-doc/sphinx/issues/8671): :confval:`highlight_options` is not working - [#8341](https://togithub.com/sphinx-doc/sphinx/issues/8341): C, fix intersphinx lookup types for names in declarations. - C, C++: in general fix intersphinx and role lookup types. - [#8683](https://togithub.com/sphinx-doc/sphinx/issues/8683): :confval:`html_last_updated_fmt` does not support UTC offset (%z) - [#8683](https://togithub.com/sphinx-doc/sphinx/issues/8683): :confval:`html_last_updated_fmt` generates wrong time zone for %Z - [#1112](https://togithub.com/sphinx-doc/sphinx/issues/1112): `download` role creates duplicated copies when relative path is specified - [#2616](https://togithub.com/sphinx-doc/sphinx/issues/2616) (fifth item): LaTeX: footnotes from captions are not clickable, and for manually numbered footnotes only first one with same number is an hyperlink - [#7576](https://togithub.com/sphinx-doc/sphinx/issues/7576): LaTeX with French babel and memoir crash: "Illegal parameter number in definition of `\FNH@prefntext`" - [#8055](https://togithub.com/sphinx-doc/sphinx/issues/8055): LaTeX (docs): A potential display bug with the LaTeX generation step in Sphinx (how to generate one-column index) - [#8072](https://togithub.com/sphinx-doc/sphinx/issues/8072): LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX - [#8214](https://togithub.com/sphinx-doc/sphinx/issues/8214): LaTeX: The :rst:role:`index` role and the glossary generate duplicate entries in the LaTeX index (if both used for same term) - [#8735](https://togithub.com/sphinx-doc/sphinx/issues/8735): LaTeX: wrong internal links in pdf to captioned code-blocks when :confval:`numfig` is not True - [#8442](https://togithub.com/sphinx-doc/sphinx/issues/8442): LaTeX: some indexed terms are ignored when using xelatex engine (or pdflatex and :confval:`latex_use_xindy` set to True) with memoir class - [#8750](https://togithub.com/sphinx-doc/sphinx/issues/8750): LaTeX: URLs as footnotes fail to show in PDF if originating from inside function type signatures - [#8780](https://togithub.com/sphinx-doc/sphinx/issues/8780): LaTeX: long words in narrow columns may not be hyphenated - [#8788](https://togithub.com/sphinx-doc/sphinx/issues/8788): LaTeX: `\titleformat` last argument in sphinx.sty should be bracketed, not braced (and is anyhow not needed) - [#8849](https://togithub.com/sphinx-doc/sphinx/issues/8849): LaTex: code-block printed out of margin (see the opt-in LaTeX syntax boolean :ref:`verbatimforcewrapsConfiguration
:date: Schedule: At any time (no schedule defined).
:vertical_traffic_light: Automerge: Disabled by config. Please merge this manually once you are satisfied.
:recycle: Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
:no_bell: Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.