doc/changes/1.8.rst
TypeError is raised when invalid latex_elements given:index: role in titles causes Use of \@icentercr doesn't match its definition error on latexpdf buildautofunction emits a warning for method objectsskipif option may remove the code block from documentation:name: option for math directive causes a crashnumfig_format is stripped of spaces and may cause
build failure:scale: image option may break PDF build if image in an admonitionparskip.sty. is not allowed'maketitle' key of :confval:latex_elements
('manual' docclass only)/latex\maketitle is overwritten with no
possibility to use original meaning in place of Sphinx custom one--tocfile\label positioning for figures with a legendfunctools.partial\pagestyle commands have been moved to the LaTeX template. No
changes in PDF, except possibly if \sphinxtableofcontents, which
contained them, had been customized in :file:conf.py. (refs: #5455)!autodoc_default_flagsautofunction emits a warning for callable objects:type: field can't process :term: references1.8.0b1
latex_use_xindy, if True (default for
xelatex/lualatex), instructs make latexpdf to use :program:xindy
for general index. Make sure your LaTeX distribution includes it.
(refs: #5134)latexmk is required for make latexpdf on Windows1.8.0b2
pygments_style settings of HTML themes
preferentiallyMakefile and make.bat are not overwritten if exists1.8.0b1
#5156: the :py:mod:sphinx.ext.graphviz extension runs dot in the
directory of the document being built instead of in the root directory of
the documentation.
#4460: extensions which stores any data to environment should return the
version of its env data structure as metadata. In detail, please see
:ref:ext-metadata.
Sphinx expects source parser modules to have supported file formats as
Parser.supported attribute
The default value of :confval:epub_author and :confval:epub_publisher are
changed from 'unknown' to the value of :confval:author. This is same as
a conf.py file sphinx-build generates.
The gettext_compact attribute is removed from document.settings
object. Please use config.gettext_compact instead.
The processing order on reading phase is changed. smart_quotes, sphinx
domains, :event:doctree-read event and versioning doctrees are invoked
earlier than so far. For more details, please read a description of
:py:meth:.Sphinx.add_transform()
#4827: All substitution_definition nodes are removed from doctree on
reading phase
docutils.conf in $HOME or /etc directories are ignored. Only
docutils.conf from confdir is obeyed.
#789: :samp: role supports to escape curly braces with backslash
#4811: The files under :confval:html_static_path are excluded from source
files.
latex: Use \sphinxcite for citation references instead \hyperref
The config value :confval:!viewcode_import is renamed to
:confval:viewcode_follow_imported_members (refs: #4035)
#1857: latex: :confval:latex_show_pagerefs does not add pagerefs for
citations
#4648: latex: Now "rubric" elements are rendered as unnumbered section title
#4983: html: The anchor for productionlist tokens has been changed
Modifying a template variable script_files in templates is allowed now.
Please use app.add_js_file() instead.
#5072: Save environment object also with only new documents
#5035: qthelp builder allows dashes in :confval:qthelp_namespace
LaTeX: with lualatex or xelatex use by default :program:xindy as
UTF-8 able replacement of :program:makeindex (refs: #5134). After
upgrading Sphinx, please clean latex build repertory of existing project
before new build.
#5163: html: hlist items are now aligned to top
highlightlang directive is processed on resolving phase
#4000: LaTeX: template changed. Following elements moved to it:
\begin{document}shorthandoff variablemaketitle variabletableofcontents variable1.8.0b2
sphinx.io.SphinxI18nReader.set_lineno_for_reporter() is deprecatedsphinx.io.SphinxI18nReader.line is deprecatedsphinx.util.i18n.find_catalog_source_file() has changed; the
gettext_compact argument has been deprecatedsphinx.util.images.guess_mimetype() has changed; the content
argument has been deprecated1.8.0b1
!source_parsers is deprecated!autodoc_default_flags is deprecated--epub option becomes default, so it is deprecated~docutils.parsers.rst.Directive)sphinx.util.docutils.directive_helper() is deprecatedsphinx.cmdline is deprecatedsphinx.make_mode is deprecatedsphinx.locale.l_() is deprecatedwarn() for HTML themes is deprecatedapp.override_domain() is deprecatedapp.add_stylesheet() is deprecatedapp.add_javascript() is deprecatedapp.import_object() is deprecatedapp.add_source_parser() has changed; the suffix argument has been
deprecatedsphinx.versioning.prepare() is deprecatedConfig.__init__() has changed; the dirname, filename and tags
argument has been deprecatedConfig.check_types() is deprecatedConfig.check_unicode() is deprecatedsphinx.application.CONFIG_FILENAME is deprecatedhighlightlang directive is deprecatedBuildEnvironment.load() is deprecatedBuildEnvironment.loads() is deprecatedBuildEnvironment.frompickle() is deprecatedenv.read_doc() is deprecatedenv.update() is deprecatedenv._read_serial() is deprecatedenv._read_parallel() is deprecatedenv.write_doctree() is deprecatedenv._nitpick_ignore is deprecatedenv.versionchanges is deprecatedenv.dump() is deprecatedenv.dumps() is deprecatedenv.topickle() is deprecatedenv.note_versionchange() is deprecatedsphinx.writers.latex.Table.caption_footnotetexts is deprecatedsphinx.writers.latex.Table.header_footnotetexts is deprecatedsphinx.writers.latex.LaTeXTranslator.footnotestack is deprecatedsphinx.writers.latex.LaTeXTranslator.in_container_literal_block is
deprecatedsphinx.writers.latex.LaTeXTranslator.next_section_ids is deprecatedsphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids is deprecatedsphinx.writers.latex.LaTeXTranslator.restrict_footnote() is deprecatedsphinx.writers.latex.LaTeXTranslator.unrestrict_footnote() is deprecatedsphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids() is deprecatedsphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids() is deprecatedsphinx.writers.latex.LaTeXTranslator.check_latex_elements() is deprecatedsphinx.writers.latex.LaTeXTranslator.bibitems is deprecatedsphinx.writers.latex.LaTeXTranslator.hlsettingstack is deprecatedsphinx.writers.latex.ExtBabel.get_shorthandoff() is deprecatedsphinx.writers.html.HTMLTranslator.highlightlang is deprecatedsphinx.writers.html.HTMLTranslator.highlightlang_base is deprecatedsphinx.writers.html.HTMLTranslator.highlightlangopts is deprecatedsphinx.writers.html.HTMLTranslator.highlightlinenothreshold is deprecatedsphinx.writers.html5.HTMLTranslator.highlightlang is deprecatedsphinx.writers.html5.HTMLTranslator.highlightlang_base is deprecatedsphinx.writers.html5.HTMLTranslator.highlightlangopts is deprecatedsphinx.writers.html5.HTMLTranslator.highlightlinenothreshold is deprecatedsphinx.ext.mathbase extension is deprecatedsphinx.ext.mathbase.math node is deprecatedsphinx.ext.mathbase.displaymath node is deprecatedsphinx.ext.mathbase.eqref node is deprecatedsphinx.ext.mathbase.is_in_section_title() is deprecatedsphinx.ext.mathbase.MathDomain is deprecatedsphinx.ext.mathbase.MathDirective is deprecatedsphinx.ext.mathbase.math_role is deprecatedsphinx.ext.mathbase.setup_math() is deprecatedsphinx.directives.other.VersionChanges is deprecatedsphinx.highlighting.PygmentsBridge.unhighlight() is deprecatedsphinx.ext.mathbase.get_node_equation_number() is deprecatedsphinx.ext.mathbase.wrap_displaymath() is deprecatedtrim_doctest_flags argument of sphinx.highlighting.PygmentsBridge
is deprecatedFor more details, see :ref:deprecation APIs list <dev-deprecated-apis>.
1.8.0b2
--tocfile option to change the filename of ToC1.8.0b1
Add :event:config-inited event
Add sphinx.config.Any to represent the config value accepts any type of
value
:confval:source_suffix allows a mapping fileext to file types
Add :confval:author as a configuration value
#2852: imgconverter: Support to convert GIF to PNG
sphinx-build command supports i18n console output
Add app.add_message_catalog() and sphinx.locale.get_translations() to
support translation for 3rd party extensions
helper function warning() for HTML themes is added
Add Domain.enumerable_nodes to manage own enumerable nodes for domains
(experimental)
Add a new keyword argument override to Application APIs
LaTeX: new key 'fvset' for :confval:latex_elements. For
XeLaTeX/LuaLaTeX its default sets fanvyvrb to use normal, not small,
fontsize in code-blocks (refs: #4793)
Add :confval:html_css_files and :confval:epub_css_files for adding CSS
files from configuration
Add :confval:html_js_files for adding JS files from configuration
#4834: Ensure set object descriptions are reproducible.
#4828: Allow to override :confval:numfig_format partially. Full definition
is not needed.
Improve warning messages during including (refs: #4818)
LaTeX: separate customizability of :rst:role:guilabel and
:rst:role:menuselection (refs: #4830)
Add Config.read() classmethod to create a new config object from
configuration file
#4866: Wrap graphviz diagrams in <div> tag
viewcode: Add :event:viewcode-find-source and
:event:viewcode-follow-imported to load source code without loading
#4785: napoleon: Add strings to translation file for localisation
#4927: Display a warning when invalid values are passed to linenothreshold option of highlight directive
C++:
cpp:texpr role as a sibling to cpp:expr.@.cpp:any and cpp:func
roles, for referencing specific function overloads.#3606: MathJax should be loaded with async attribute
html: Output canonical_url metadata if :confval:html_baseurl set (refs:
#4193)
#5029: autosummary: expose inherited_members to template
#3784: mathjax: Add :confval:mathjax_options to give options to script tag
for mathjax
#726, #969: mathjax: Add :confval:mathjax_config to give in-line
configurations for mathjax
#4362: latex: Don't overwrite .tex file if document not changed
#1431: latex: Add alphanumeric enumerated list support
Add :confval:latex_use_xindy for UTF-8 savvy indexing, defaults to True
if :confval:latex_engine is 'xelatex' or 'lualatex'. (refs: #5134,
#5192, #5212)
#4976: SphinxLoggerAdapter.info() now supports location parameter
#5122: setuptools: support nitpicky option
#2820: autoclass directive supports nested class
Add app.add_html_math_renderer() to register a math renderer for HTML
Apply :confval:trim_doctest_flags to all builders (cf. text, manpages)
#5140: linkcheck: Add better Accept header to HTTP client
#4614: sphinx-build: Add --keep-going option to show all warnings
Add :rst:role:math:numref role to refer equations (Same as :rst:role:eq)
quickstart: epub builder is enabled by default
#5246: Add :confval:singlehtml_sidebars to configure sidebars for singlehtml
builder
#5273: doctest: Skip doctest conditionally
#5306: autodoc: emit a warning for invalid typehints
#4075, #5215: autodoc: Add :confval:autodoc_default_options which accepts
option values as dict
1.8.0b2
pygments_style of theme was overridden by conf.py
by default:members: causes :special-members: not to be shown:download:, duplicate names, and
parallel builds1.8.0b1
1.8.0b1
sphinx.ext.pngmath extension1.8.0b1