doc/changes/1.4.rst
add_source_parser() crashes in debug modesphinx.ext.autodoc crashes with plain Callablenote directive.sphinx.ext.inheritance_diagramhasdoc() function in Jinja2 template. It will detect
genindex, search also.:nowrap: option specifiedintersphinx_mappingcode-block and literalinclude does not define hyperlink
target using its caption automatically.applehelp: Sphinx crashes if hiutil or codesign commands not found
Fix make clean abort issue when build dir contains regular files like
DS_Store.
Reduce epubcheck warnings/errors:
#2778: Fix autodoc crashes if obj.dict is a property method and raises exception
Fix duplicated toc in epub3 output.
#2775: Fix failing linkcheck with servers not supporting identity encoding
#2833: Fix formatting instance annotations in ext.autodoc.
#1911: -D option of sphinx-build does not override the extensions
variable
#2789: sphinx.ext.intersphinx generates wrong hyperlinks if the inventory is
given
parsing errors for caption of code-blocks are displayed in document (ref: #2845)
#2846: singlehtml builder does not include figure numbers
#2816: Fix data from builds cluttering the Domain.initial_data class
attributes
\includegraphics to refer to Sphinx custom variant is
deprecated; in future it will revert to original LaTeX macro, custom one
already has alternative name \sphinxincludegraphics.!latex_keep_old_macro_names, defaults to True.
If False, lets macros (for text styling) be defined
only with \sphinx-prefixed nameslatex_keep_old_macro_names=False (ref 2675)sphinx.ext.intersphinx crashes with six-1.4.1float package needed for 'figure_align': 'H' latex optiontoctree generates empty bullet_list if :titlesonly: specifiedsphinx.ext.viewcode uses python2 highlighter by defaultmake latexpdf generates lots of hyperref
warningssphinx.ext.autodoc does not access propertymethods which raises any
exceptionssphinx.ext.intersphinxhtml_file_suffix is setUnderfull \hbox (badness 10000) warnings from title pagealt attribute for image
tags of SVG source, required to validate and now consistent w/ other formats.\begin{\minipage} typo in sphinx.sty from 1.4.2 (ref: 68becb1)sphinx.ext.autodoc: memory addresses were shownwidth option of figure directive does not work if align option
specified at same time (ref: #2595)inputenc package breaks compiling under lualatex and xelatexsphinx.ext.intersphinxNow :confval:suppress_warnings accepts following configurations
(ref: #2451, #2466):
app.add_nodeapp.add_directiveapp.add_roleapp.add_generic_roleapp.add_source_parserimage.data_uriimage.nonlocal_uri#2453: LaTeX writer allows page breaks in topic contents; and their horizontal extent now fits in the line width (with shadow in margin). Also warning-type admonitions allow page breaks and their vertical spacing has been made more coherent with the one for hint-type notices (ref #2446).
#2459: the framing of literal code-blocks in LaTeX output (and not only the code lines themselves) obey the indentation in lists or quoted blocks.
#2343: the long source lines in code-blocks are wrapped (without modifying the line numbering) in LaTeX output (ref #1534, #2304).
needs_sphinx if loading
extensions failed:align: was
specifiedtyping backport package causes autodoc errors with python 2.7sphinx.ext.intersphinx crashes if non-string value is used for key of
intersphinx_mappingintersphinx_mapping disallows non alphanumeric keyssphinx.ext.autosummary
overflow lines at LaTeX writerrst_prolog and rst_epilog affect to non reST sourcessphinx.ext.imgmath crashes if subprocess raises errorsphinx.ext.imgmath: Invalid argument are passed to dvisvgmlatex_show_urls overflows linestoday_fmt and html_last_updated_fmt is back to
strftime format again. Locale Date Markup Language is also supported for
backward compatibility until Sphinx 1.5.extern and thread_local.typedef, using, and
type, depending on the style of declaration.PorterStemmer package support. Use PyStemmer instead of
PorterStemmer to accelerate stemming.sphinx_rtd_theme has become optional. Please install it manually.
Refs #2087, #2086, #1845 and #2097. Thanks to Victor Zverovich.exclude_patterns default
values in conf.py that will be provided on sphinx-quickstart.html_title accepts string values only. And the None
value cannot be accepted.sphinx.ext.graphviz: show graph image in inline by defaultmanpage role now generate sphinx.addnodes.manpage
node instead of sphinx.addnodes.literal_emphasis node.html_extra_path also copies dotfiles in the extra directory,
and refers to :confval:exclude_patterns to exclude extra files and
directories.term node and the each terms in the
term node are separated by termsep node. In new implementation, each terms
are converted into individual term nodes and termsep node is removed.
By this change, output layout of every builders are changed a bit.highlight_language = "python" to conf.py.Locale Date Markup Language <https://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns>_ like
"MMMM dd, YYYY" is default format for today_fmt and
html_last_updated_fmt. However strftime format like "%B %d, %Y" is also
supported for backward compatibility until Sphinx 1.5. Later format will be
disabled from Sphinx 1.5.latex_use_parts is deprecated now. Use latex_toplevel_sectioning
instead.\url{URL} macro instead of \href{URL}{URL} in LaTeX writer... type:: T = int).namespace-push and
namespace-pop.:class: option to code-block directive.graphviz_dot option to graphviz directives to switch the dot
commanddummy builder: syntax check without output.math_number_all option to number all displayed math in math
extensionsneeds_sphinx supports micro version comparisontodo_link_only to avoid file path and line indication on
:rst:dir:todolist. Thanks to Francesco Montesano.imagesize package to obtain size of images.!.sphinx.ext.autosectionlabel extension to allow reference
sections using its title. Thanks to Tadhg O'Higgins.language='ja'.glossary-directive.\tablecontinued macro to redefine the style of continued
label for longtables... image:: filename.*language and
:confval:figure_language_filenamelatex_elements["passoptionstopackages"] option to call
PassOptionsToPackages in early stage of preambles.\titleref macro to redefine the style of title-reference
roles.\menuselection and \accelerator macros to redefine the style of
menuselection roles.\crossref macro to redefine the style of references\termref macro to redefine the style of term roles.suppress_warnings to suppress arbitrary warning message
(experimental)latex_toplevel_sectioning to switch the top level sectioning of
LaTeX document.make json to fail.image/gif from supported_image_types of LaTeX writer (#2272)Sphinx.add_crossref_type is useddefault. This means that source
code is highlighted as Python 3 (which is mostly a superset of Python 2) if
possible. To get the old behavior back, add highlight_language = "python"
to conf.py.xcdraw option
from xcolor package.#foo.rst by default.part or chapter is used for top_sectionleveltoctree() in templates generates broken links in
SingleHTMLBuilder.html_last_updated_fmt. Thanks to Ralf
Hemmecke.