doc/changes/2.4.rst
*args and **kwarg in type comments are not handled
properly:attr: reference to property is brokenautodoc.typehints crashed when variable has unbound object
as a valueenv.indexentriesdecode argument of sphinx.pycode.ModuleAnalyzer()sphinx.directives.other.Indexsphinx.environment.temp_data['gloss_entries']sphinx.environment.BuildEnvironment.indexentriessphinx.environment.collectors.indexentries.IndexEntriesCollectorsphinx.ext.apidoc.INITPYsphinx.ext.apidoc.shall_skip()sphinx.io.FiletypeNotFoundErrorsphinx.io.get_filetype()sphinx.pycode.ModuleAnalyzer.encodingsphinx.roles.Indexsphinx.util.detect_encoding()sphinx.util.get_module_source()sphinx.util.inspect.Signaturesphinx.util.inspect.safe_getmembers()sphinx.writers.latex.LaTeXTranslator.settings.authorsphinx.writers.latex.LaTeXTranslator.settings.contentsnamesphinx.writers.latex.LaTeXTranslator.settings.docclasssphinx.writers.latex.LaTeXTranslator.settings.docnamesphinx.writers.latex.LaTeXTranslator.settings.titlesphinx.writers.latex.ADDITIONAL_SETTINGSsphinx.writers.latex.DEFAULT_SETTINGSsphinx.writers.latex.LUALATEX_DEFAULT_FONTPKGsphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKGsphinx.writers.latex.XELATEX_DEFAULT_FONTPKGsphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKGsphinx.ext.durations to inspect which documents slow
down the build:class: option:scale: option of image/figure directive not working for SVG
images (imagesize-1.2.0 or above is required)autodoc-before-process-signature# type: (str) -> str)
annotation (python3.8+ or typed_ast <https://github.com/python/typed_ast>_
is required)sphinx.ext.autodoc.typehints. It shows
typehints as object description if autodoc_typehints = "description" set.
This is an experimental extension and it will be integrated into autodoc core
in Sphinx 3.0object-description-transformpy:data and :rst:dir:py:attribute take new options
named :type: and :value: to describe its type and initial value:py:attr: is able to refer properties again-q option for quiet mode#6925: html: Remove redundant type="text/javascript" from <script> elements
#7112: html: SVG image is not layouted as float even if aligned
#6906, #6907: autodoc: failed to read the source codes encoded in cp1251
#6961: latex: warning for babel shown twice
#7059: latex: LaTeX compilation falls into infinite loop (wrapfig issue)
#6581: latex: :reversed: option for toctree does not effect to LaTeX build
#6559: Wrong node-ids are generated in glossary directive
#6986: apidoc: misdetects module name for .so file inside module
#6899: apidoc: private members are not shown even if --private given
#6327: apidoc: Support a python package consisted of init.so file
#6999: napoleon: fails to parse tilde in :exc: role
#7019: gettext: Absolute path used in message catalogs
#7023: autodoc: nested partial functions are not listed
#7023: autodoc: partial functions imported from other modules are listed as module members without :impoprted-members: option
#6889: autodoc: Trailing comma in :members:: option causes cryptic warning
#6568: autosummary: autosummary_imported_members is ignored on generating
a stub file for submodule
#7055: linkcheck: redirect is treated as an error
#7088: HTML template: If navigation_with_keys option is activated,
modifier keys are ignored, which means the feature can interfere with browser
features
#7090: std domain: Can't assign numfig-numbers for custom container nodes
#7106: std domain: enumerated nodes are marked as duplicated when extensions
call note_explicit_target()
#7095: dirhtml: Cross references are broken via intersphinx and :doc: role
C++:
struct role in some cases.var/member role for function
parameters.#7097: Filenames of images generated by
sphinx.transforms.post_transforms.images.ImageConverter
or its subclasses (used for latex build) are now sanitized,
to prevent broken paths