sphinx-doc/sphinx (Sphinx)
### [`v1.8.6`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-186-released-Nov-18-2021)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.5...v1.8.6)
\=====================================
## Dependencies
- [#9807](https://togithub.com/sphinx-doc/sphinx/issues/9807): Restrict Docutils to 0.17.x or older
### [`v1.8.5`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-185-released-Mar-10-2019)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.4...v1.8.5)
\=====================================
## Bugs fixed
- LaTeX: Remove extraneous space after author names on PDF title page (refs:
[#6004](https://togithub.com/sphinx-doc/sphinx/issues/6004))
- [#6026](https://togithub.com/sphinx-doc/sphinx/issues/6026): LaTeX: A cross reference to definition list does not work
- [#6046](https://togithub.com/sphinx-doc/sphinx/issues/6046): LaTeX: `TypeError` is raised when invalid latex_elements given
- [#6067](https://togithub.com/sphinx-doc/sphinx/issues/6067): LaTeX: images having a target are concatenated to next line
- [#6067](https://togithub.com/sphinx-doc/sphinx/issues/6067): LaTeX: images having a target are not aligned even if specified
- [#6149](https://togithub.com/sphinx-doc/sphinx/issues/6149): LaTeX: `:index:` role in titles causes `Use of \@icentercr doesn't
match its definition` error on latexpdf build
- [#6019](https://togithub.com/sphinx-doc/sphinx/issues/6019): imgconverter: Including multipage PDF fails
- [#6047](https://togithub.com/sphinx-doc/sphinx/issues/6047): autodoc: `autofunction` emits a warning for method objects
- [#6028](https://togithub.com/sphinx-doc/sphinx/issues/6028): graphviz: Ensure the graphviz filenames are reproducible
- [#6068](https://togithub.com/sphinx-doc/sphinx/issues/6068): doctest: `skipif` option may remove the code block from documentation
- [#6136](https://togithub.com/sphinx-doc/sphinx/issues/6136): `:name:` option for `math` directive causes a crash
- [#6139](https://togithub.com/sphinx-doc/sphinx/issues/6139): intersphinx: ValueError on failure reporting
- [#6135](https://togithub.com/sphinx-doc/sphinx/issues/6135): changes: Fix UnboundLocalError when any module found
- [#3859](https://togithub.com/sphinx-doc/sphinx/issues/3859): manpage: code-block captions are not displayed correctly
### [`v1.8.4`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-184-released-Feb-03-2019)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.3...v1.8.4)
\=====================================
## Bugs fixed
- [#3707](https://togithub.com/sphinx-doc/sphinx/issues/3707): latex: no bold checkmark (✔) available.
- [#5605](https://togithub.com/sphinx-doc/sphinx/issues/5605): with the documentation language set to Chinese, English words could not
be searched.
- [#5889](https://togithub.com/sphinx-doc/sphinx/issues/5889): LaTeX: user `numfig_format` is stripped of spaces and may cause
build failure
- C++, fix hyperlinks for declarations involving east cv-qualifiers.
- [#5755](https://togithub.com/sphinx-doc/sphinx/issues/5755): C++, fix duplicate declaration error on function templates with
constraints in the return type.
- C++, parse unary right fold expressions and binary fold expressions.
- pycode could not handle egg files on windows
- [#5928](https://togithub.com/sphinx-doc/sphinx/issues/5928): KeyError: 'DOCUTILSCONFIG' when running build
- [#5936](https://togithub.com/sphinx-doc/sphinx/issues/5936): LaTeX: PDF build broken by inclusion of image taller than page height
in an admonition
- [#5231](https://togithub.com/sphinx-doc/sphinx/issues/5231): "make html" does not read and build "po" files in "locale" dir
- [#5954](https://togithub.com/sphinx-doc/sphinx/issues/5954): `:scale:` image option may break PDF build if image in an admonition
- [#5966](https://togithub.com/sphinx-doc/sphinx/issues/5966): mathjax has not been loaded on incremental build
- [#5960](https://togithub.com/sphinx-doc/sphinx/issues/5960): LaTeX: modified PDF layout since September 2018 TeXLive update of
:file:`parskip.sty`
- [#5948](https://togithub.com/sphinx-doc/sphinx/issues/5948): LaTeX: duplicated labels are generated for sections
- [#5958](https://togithub.com/sphinx-doc/sphinx/issues/5958): versionadded directive causes crash with Python 3.5.0
- [#5995](https://togithub.com/sphinx-doc/sphinx/issues/5995): autodoc: autodoc_mock_imports conflict with metaclass on Python 3.7
- [#5871](https://togithub.com/sphinx-doc/sphinx/issues/5871): texinfo: a section title `.` is not allowed
### [`v1.8.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-183-released-Dec-26-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.2...v1.8.3)
\=====================================
## Features added
- LaTeX: it is possible to insert custom material to appear on back of title
page, see discussion of `'maketitle'` key of :confval:`latex_elements`
(`'manual'` docclass only)
## Bugs fixed
- [#5725](https://togithub.com/sphinx-doc/sphinx/issues/5725): mathjax: Use CDN URL for "latest" version by default
- [#5460](https://togithub.com/sphinx-doc/sphinx/issues/5460): html search does not work with some 3rd party themes
- [#5520](https://togithub.com/sphinx-doc/sphinx/issues/5520): LaTeX, caption package incompatibility since Sphinx 1.6
- [#5614](https://togithub.com/sphinx-doc/sphinx/issues/5614): autodoc: incremental build is broken when builtin modules are imported
- [#5627](https://togithub.com/sphinx-doc/sphinx/issues/5627): qthelp: index.html missing in QtHelp
- [#5659](https://togithub.com/sphinx-doc/sphinx/issues/5659): linkcheck: crashes for a hyperlink containing multibyte character
- [#5754](https://togithub.com/sphinx-doc/sphinx/issues/5754): DOC: Fix some mistakes in :doc:`/latex`
- [#5810](https://togithub.com/sphinx-doc/sphinx/issues/5810): LaTeX: sphinxVerbatim requires explicit "hllines" set-up since 1.6.6
(refs: [#1238](https://togithub.com/sphinx-doc/sphinx/issues/1238))
- [#5636](https://togithub.com/sphinx-doc/sphinx/issues/5636): C++, fix parsing of floating point literals.
- [#5496](https://togithub.com/sphinx-doc/sphinx/issues/5496) (again): C++, fix assertion in partial builds with duplicates.
- [#5724](https://togithub.com/sphinx-doc/sphinx/issues/5724): quickstart: sphinx-quickstart fails when $LC_ALL is empty
- [#1956](https://togithub.com/sphinx-doc/sphinx/issues/1956): Default conf.py is not PEP8-compliant
- [#5849](https://togithub.com/sphinx-doc/sphinx/issues/5849): LaTeX: document class `\maketitle` is overwritten with no
possibility to use original meaning in place of Sphinx custom one
- [#5834](https://togithub.com/sphinx-doc/sphinx/issues/5834): apidoc: wrong help for `--tocfile`
- [#5800](https://togithub.com/sphinx-doc/sphinx/issues/5800): todo: crashed if todo is defined in TextElement
- [#5846](https://togithub.com/sphinx-doc/sphinx/issues/5846): htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files
- htmlhelp: broken .hhk file generated when title contains a double quote
### [`v1.8.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-182-released-Nov-11-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.1...v1.8.2)
\=====================================
## Incompatible changes
- [#5497](https://togithub.com/sphinx-doc/sphinx/issues/5497): Do not include MathJax.js and jsmath.js unless it is really needed
## Features added
- [#5471](https://togithub.com/sphinx-doc/sphinx/issues/5471): Show appropriate deprecation warnings
## Bugs fixed
- [#5490](https://togithub.com/sphinx-doc/sphinx/issues/5490): latex: enumerated list causes a crash with recommonmark
- [#5492](https://togithub.com/sphinx-doc/sphinx/issues/5492): sphinx-build fails to build docs w/ Python < 3.5.2
- [#3704](https://togithub.com/sphinx-doc/sphinx/issues/3704): latex: wrong `\label` positioning for figures with a legend
- [#5496](https://togithub.com/sphinx-doc/sphinx/issues/5496): C++, fix assertion when a symbol is declared more than twice.
- [#5493](https://togithub.com/sphinx-doc/sphinx/issues/5493): gettext: crashed with broken template
- [#5495](https://togithub.com/sphinx-doc/sphinx/issues/5495): csv-table directive with file option in included file is broken (refs:
[#4821](https://togithub.com/sphinx-doc/sphinx/issues/4821))
- [#5498](https://togithub.com/sphinx-doc/sphinx/issues/5498): autodoc: unable to find type hints for a `functools.partial`
- [#5480](https://togithub.com/sphinx-doc/sphinx/issues/5480): autodoc: unable to find type hints for unresolvable Forward references
- [#5419](https://togithub.com/sphinx-doc/sphinx/issues/5419): incompatible math_block node has been generated
- [#5548](https://togithub.com/sphinx-doc/sphinx/issues/5548): Fix ensuredir() in case of pre-existing file
- [#5549](https://togithub.com/sphinx-doc/sphinx/issues/5549): graphviz Correctly deal with non-existing static dir
- [#3002](https://togithub.com/sphinx-doc/sphinx/issues/3002): i18n: multiple footnote_references referring same footnote cause
duplicated node_ids
- [#5563](https://togithub.com/sphinx-doc/sphinx/issues/5563): latex: footnote_references generated by extension causes a LaTeX
builder crash
- [#5561](https://togithub.com/sphinx-doc/sphinx/issues/5561): make all-pdf fails with old xindy version
- [#5557](https://togithub.com/sphinx-doc/sphinx/issues/5557): quickstart: --no-batchfile isn't honored
- [#3080](https://togithub.com/sphinx-doc/sphinx/issues/3080): texinfo: multiline rubrics are broken
- [#3080](https://togithub.com/sphinx-doc/sphinx/issues/3080): texinfo: multiline citations are broken
### [`v1.8.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-181-released-Sep-22-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.0...v1.8.1)
\=====================================
## Incompatible changes
- LaTeX `\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](https://togithub.com/sphinx-doc/sphinx/issues/5455))
## Bugs fixed
- [#5418](https://togithub.com/sphinx-doc/sphinx/issues/5418): Incorrect default path for sphinx-build -d/doctrees files
- [#5421](https://togithub.com/sphinx-doc/sphinx/issues/5421): autodoc emits deprecation warning for :confval:`autodoc_default_flags`
- [#5422](https://togithub.com/sphinx-doc/sphinx/issues/5422): lambda object causes PicklingError on storing environment
- [#5417](https://togithub.com/sphinx-doc/sphinx/issues/5417): Sphinx fails to build with syntax error in Python 2.7.5
- [#4911](https://togithub.com/sphinx-doc/sphinx/issues/4911): add latexpdf to make.bat for non make-mode
- [#5436](https://togithub.com/sphinx-doc/sphinx/issues/5436): Autodoc does not work with enum subclasses with properties/methods
- [#5437](https://togithub.com/sphinx-doc/sphinx/issues/5437): autodoc: crashed on modules importing eggs
- [#5433](https://togithub.com/sphinx-doc/sphinx/issues/5433): latex: ImportError: cannot import name 'DEFAULT_SETTINGS'
- [#5431](https://togithub.com/sphinx-doc/sphinx/issues/5431): autodoc: `autofunction` emits a warning for callable objects
- [#5457](https://togithub.com/sphinx-doc/sphinx/issues/5457): Fix TypeError in error message when override is prohibited
- [#5453](https://togithub.com/sphinx-doc/sphinx/issues/5453): PDF builds of 'howto' documents have no page numbers
- [#5463](https://togithub.com/sphinx-doc/sphinx/issues/5463): mathbase: math_role and MathDirective was disappeared in 1.8.0
- [#5454](https://togithub.com/sphinx-doc/sphinx/issues/5454): latex: Index has disappeared from PDF for Japanese documents
- [#5432](https://togithub.com/sphinx-doc/sphinx/issues/5432): py domain: `:type:` field can't process `:term:` references
- [#5426](https://togithub.com/sphinx-doc/sphinx/issues/5426): py domain: TypeError has been raised for class attribute
### [`v1.8.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-180-released-Sep-13-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.9...v1.8.0)
\=====================================
## Dependencies
1.8.0b1
- LaTeX: :confval:`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](https://togithub.com/sphinx-doc/sphinx/issues/5134))
- LaTeX: `latexmk` is required for `make latexpdf` on Windows
## Incompatible changes
1.8.0b2
- [#5282](https://togithub.com/sphinx-doc/sphinx/issues/5282): html theme: refer `pygments_style` settings of HTML themes
preferentially
- The URL of download files are changed
- [#5127](https://togithub.com/sphinx-doc/sphinx/issues/5127): quickstart: `Makefile` and `make.bat` are not overwritten if exists
1.8.0b1
- [#5156](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/789): `:samp:` role supports to escape curly braces with backslash
- [#4811](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/4035))
- [#1857](https://togithub.com/sphinx-doc/sphinx/issues/1857): latex: :confval:`latex_show_pagerefs` does not add pagerefs for
citations
- [#4648](https://togithub.com/sphinx-doc/sphinx/issues/4648): latex: Now "rubric" elements are rendered as unnumbered section title
- [#4983](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/5072): Save environment object also with only new documents
- [#5035](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/5134)). After
upgrading Sphinx, please clean latex build repertory of existing project
before new build.
- [#5163](https://togithub.com/sphinx-doc/sphinx/issues/5163): html: hlist items are now aligned to top
- `highlightlang` directive is processed on resolving phase
- [#4000](https://togithub.com/sphinx-doc/sphinx/issues/4000): LaTeX: template changed. Following elements moved to it:
- `\begin{document}`
- `shorthandoff` variable
- `maketitle` variable
- `tableofcontents` variable
## Deprecated
1.8.0b2
- `sphinx.io.SphinxI18nReader.set_lineno_for_reporter()` is deprecated
- `sphinx.io.SphinxI18nReader.line` is deprecated
- `sphinx.util.i18n.find_catalog_source_file()` has changed; the
*gettext_compact* argument has been deprecated
- [#5403](https://togithub.com/sphinx-doc/sphinx/issues/5403): `sphinx.util.images.guess_mimetype()` has changed; the *content*
argument has been deprecated
1.8.0b1
- :confval:`source_parsers` is deprecated
- :confval:`autodoc_default_flags` is deprecated
- quickstart: `--epub` option becomes default, so it is deprecated
- Drop function based directive support. For now, Sphinx only supports class
based directives (see :class:`~docutils.parsers.rst.Directive`)
- `sphinx.util.docutils.directive_helper()` is deprecated
- `sphinx.cmdline` is deprecated
- `sphinx.make_mode` is deprecated
- `sphinx.locale.l_()` is deprecated
- [#2157](https://togithub.com/sphinx-doc/sphinx/issues/2157): helper function `warn()` for HTML themes is deprecated
- `app.override_domain()` is deprecated
- `app.add_stylesheet()` is deprecated
- `app.add_javascript()` is deprecated
- `app.import_object()` is deprecated
- `app.add_source_parser()` has changed; the *suffix* argument has been
deprecated
- `sphinx.versioning.prepare()` is deprecated
- `Config.__init__()` has changed; the *dirname*, *filename* and *tags*
argument has been deprecated
- `Config.check_types()` is deprecated
- `Config.check_unicode()` is deprecated
- `sphinx.application.CONFIG_FILENAME` is deprecated
- `highlightlang` directive is deprecated
- `BuildEnvironment.load()` is deprecated
- `BuildEnvironment.loads()` is deprecated
- `BuildEnvironment.frompickle()` is deprecated
- `env.read_doc()` is deprecated
- `env.update()` is deprecated
- `env._read_serial()` is deprecated
- `env._read_parallel()` is deprecated
- `env.write_doctree()` is deprecated
- `env._nitpick_ignore` is deprecated
- `env.versionchanges` is deprecated
- `env.dump()` is deprecated
- `env.dumps()` is deprecated
- `env.topickle()` is deprecated
- `env.note_versionchange()` is deprecated
- `sphinx.writers.latex.Table.caption_footnotetexts` is deprecated
- `sphinx.writers.latex.Table.header_footnotetexts` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.footnotestack` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.in_container_literal_block` is
deprecated
- `sphinx.writers.latex.LaTeXTranslator.next_section_ids` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.restrict_footnote()` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.check_latex_elements()` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.bibitems` is deprecated
- `sphinx.writers.latex.LaTeXTranslator.hlsettingstack` is deprecated
- `sphinx.writers.latex.ExtBabel.get_shorthandoff()` is deprecated
- `sphinx.writers.html.HTMLTranslator.highlightlang` is deprecated
- `sphinx.writers.html.HTMLTranslator.highlightlang_base` is deprecated
- `sphinx.writers.html.HTMLTranslator.highlightlangopts` is deprecated
- `sphinx.writers.html.HTMLTranslator.highlightlinenothreshold` is deprecated
- `sphinx.writers.html5.HTMLTranslator.highlightlang` is deprecated
- `sphinx.writers.html5.HTMLTranslator.highlightlang_base` is deprecated
- `sphinx.writers.html5.HTMLTranslator.highlightlangopts` is deprecated
- `sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold` is deprecated
- `sphinx.ext.mathbase` extension is deprecated
- `sphinx.ext.mathbase.math` node is deprecated
- `sphinx.ext.mathbase.displaymath` node is deprecated
- `sphinx.ext.mathbase.eqref` node is deprecated
- `sphinx.ext.mathbase.is_in_section_title()` is deprecated
- `sphinx.ext.mathbase.MathDomain` is deprecated
- `sphinx.ext.mathbase.MathDirective` is deprecated
- `sphinx.ext.mathbase.math_role` is deprecated
- `sphinx.ext.mathbase.setup_math()` is deprecated
- `sphinx.directives.other.VersionChanges` is deprecated
- `sphinx.highlighting.PygmentsBridge.unhighlight()` is deprecated
- `sphinx.ext.mathbase.get_node_equation_number()` is deprecated
- `sphinx.ext.mathbase.wrap_displaymath()` is deprecated
- The `trim_doctest_flags` argument of `sphinx.highlighting.PygmentsBridge`
is deprecated
For more details, see :ref:`deprecation APIs list `.
## Features added
1.8.0b2
- [#5388](https://togithub.com/sphinx-doc/sphinx/issues/5388): Ensure frozen object descriptions are reproducible
- [#5362](https://togithub.com/sphinx-doc/sphinx/issues/5362): apidoc: Add `--tocfile` option to change the filename of ToC
1.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](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/4834): Ensure set object descriptions are reproducible.
- [#4828](https://togithub.com/sphinx-doc/sphinx/issues/4828): Allow to override :confval:`numfig_format` partially. Full definition
is not needed.
- Improve warning messages during including (refs: [#4818](https://togithub.com/sphinx-doc/sphinx/issues/4818))
- LaTeX: separate customizability of :rst:role:`guilabel` and
:rst:role:`menuselection` (refs: [#4830](https://togithub.com/sphinx-doc/sphinx/issues/4830))
- Add `Config.read()` classmethod to create a new config object from
configuration file
- [#4866](https://togithub.com/sphinx-doc/sphinx/issues/4866): Wrap graphviz diagrams in `
` tag
- viewcode: Add :event:`viewcode-find-source` and
:event:`viewcode-follow-imported` to load source code without loading
- [#4785](https://togithub.com/sphinx-doc/sphinx/issues/4785): napoleon: Add strings to translation file for localisation
- [#4927](https://togithub.com/sphinx-doc/sphinx/issues/4927): Display a warning when invalid values are passed to linenothreshold
option of highlight directive
- C++:
- Add a `cpp:texpr` role as a sibling to `cpp:expr`.
- Add support for unions.
- [#3593](https://togithub.com/sphinx-doc/sphinx/issues/3593), [#2683](https://togithub.com/sphinx-doc/sphinx/issues/2683): add support for anonymous entities using names staring with
`@`.
- [#5147](https://togithub.com/sphinx-doc/sphinx/issues/5147): add support for (most) character literals.
- Cross-referencing entities inside primary templates is supported,
and now properly documented.
- [#1552](https://togithub.com/sphinx-doc/sphinx/issues/1552): add new cross-referencing format for `cpp:any` and `cpp:func`
roles, for referencing specific function overloads.
- [#3606](https://togithub.com/sphinx-doc/sphinx/issues/3606): MathJax should be loaded with async attribute
- html: Output `canonical_url` metadata if :confval:`html_baseurl` set (refs:
[#4193](https://togithub.com/sphinx-doc/sphinx/issues/4193))
- [#5029](https://togithub.com/sphinx-doc/sphinx/issues/5029): autosummary: expose `inherited_members` to template
- [#3784](https://togithub.com/sphinx-doc/sphinx/issues/3784): mathjax: Add :confval:`mathjax_options` to give options to script tag
for mathjax
- [#726](https://togithub.com/sphinx-doc/sphinx/issues/726), [#969](https://togithub.com/sphinx-doc/sphinx/issues/969): mathjax: Add :confval:`mathjax_config` to give in-line
configurations for mathjax
- [#4362](https://togithub.com/sphinx-doc/sphinx/issues/4362): latex: Don't overwrite .tex file if document not changed
- [#1431](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/5134),
[#5192](https://togithub.com/sphinx-doc/sphinx/issues/5192), [#5212](https://togithub.com/sphinx-doc/sphinx/issues/5212))
- [#4976](https://togithub.com/sphinx-doc/sphinx/issues/4976): `SphinxLoggerAdapter.info()` now supports `location` parameter
- [#5122](https://togithub.com/sphinx-doc/sphinx/issues/5122): setuptools: support nitpicky option
- [#2820](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/5140): linkcheck: Add better Accept header to HTTP client
- [#4614](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/5246): Add :confval:`singlehtml_sidebars` to configure sidebars for singlehtml
builder
- [#5273](https://togithub.com/sphinx-doc/sphinx/issues/5273): doctest: Skip doctest conditionally
- [#5306](https://togithub.com/sphinx-doc/sphinx/issues/5306): autodoc: emit a warning for invalid typehints
- [#4075](https://togithub.com/sphinx-doc/sphinx/issues/4075), [#5215](https://togithub.com/sphinx-doc/sphinx/issues/5215): autodoc: Add :confval:`autodoc_default_options` which accepts
option values as dict
## Bugs fixed
1.8.0b2
- html: search box overrides to other elements if scrolled
- i18n: warnings for translation catalogs have wrong line numbers (refs: [#5321](https://togithub.com/sphinx-doc/sphinx/issues/5321))
- [#5325](https://togithub.com/sphinx-doc/sphinx/issues/5325): latex: cross references has been broken by multiply labeled objects
- C++, fixes for symbol addition and lookup. Lookup should no longer break
in partial builds. See also [#5337](https://togithub.com/sphinx-doc/sphinx/issues/5337).
- [#5348](https://togithub.com/sphinx-doc/sphinx/issues/5348): download reference to remote file is not displayed
- [#5282](https://togithub.com/sphinx-doc/sphinx/issues/5282): html theme: `pygments_style` of theme was overridden by `conf.py`
by default
- [#4379](https://togithub.com/sphinx-doc/sphinx/issues/4379): toctree shows confusing warning when document is excluded
- [#2401](https://togithub.com/sphinx-doc/sphinx/issues/2401): autodoc: `:members:` causes `:special-members:` not to be shown
- autodoc: ImportError is replaced by AttributeError for deeper module
- [#2720](https://togithub.com/sphinx-doc/sphinx/issues/2720), [#4034](https://togithub.com/sphinx-doc/sphinx/issues/4034): Incorrect links with `:download:`, duplicate names, and
parallel builds
- [#5290](https://togithub.com/sphinx-doc/sphinx/issues/5290): autodoc: failed to analyze source code in egg package
- [#5399](https://togithub.com/sphinx-doc/sphinx/issues/5399): Sphinx crashes if unknown po file exists
1.8.0b1
- i18n: message catalogs were reset on each initialization
- [#4850](https://togithub.com/sphinx-doc/sphinx/issues/4850): latex: footnote inside footnote was not rendered
- [#4945](https://togithub.com/sphinx-doc/sphinx/issues/4945): i18n: fix lang_COUNTRY not fallback correctly for IndexBuilder. Thanks
to Shengjing Zhu.
- [#4983](https://togithub.com/sphinx-doc/sphinx/issues/4983): productionlist directive generates invalid IDs for the tokens
- [#5132](https://togithub.com/sphinx-doc/sphinx/issues/5132): lualatex: PDF build fails if indexed word starts with Unicode character
- [#5133](https://togithub.com/sphinx-doc/sphinx/issues/5133): latex: index headings "Symbols" and "Numbers" not internationalized
- [#5114](https://togithub.com/sphinx-doc/sphinx/issues/5114): sphinx-build: Handle errors on scanning documents
- epub: spine has been broken when "self" is listed on toctree (refs: [#4611](https://togithub.com/sphinx-doc/sphinx/issues/4611))
- [#344](https://togithub.com/sphinx-doc/sphinx/issues/344): autosummary does not understand docstring of module level attributes
- [#5191](https://togithub.com/sphinx-doc/sphinx/issues/5191): C++, prevent nested declarations in functions to avoid lookup problems.
- [#5126](https://togithub.com/sphinx-doc/sphinx/issues/5126): C++, add missing isPack method for certain template parameter types.
- [#5187](https://togithub.com/sphinx-doc/sphinx/issues/5187): C++, parse attributes on declarators as well.
- C++, parse delete expressions and basic new expressions as well.
- [#5002](https://togithub.com/sphinx-doc/sphinx/issues/5002): graphviz: SVGs do not adapt to the column width
## Features removed
1.8.0b1
- `sphinx.ext.pngmath` extension
## Documentation
1.8.0b1
- [#5083](https://togithub.com/sphinx-doc/sphinx/issues/5083): Fix wrong make.bat option for internationalization.
- [#5115](https://togithub.com/sphinx-doc/sphinx/issues/5115): napoleon: add admonitions added by [#4613](https://togithub.com/sphinx-doc/sphinx/issues/4613) to the docs.
### [`v1.7.9`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-179-released-Sep-05-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.8...v1.7.9)
\=====================================
## Features added
- [#5359](https://togithub.com/sphinx-doc/sphinx/issues/5359): Make generated texinfo files reproducible by sorting the anchors
## Bugs fixed
- [#5361](https://togithub.com/sphinx-doc/sphinx/issues/5361): crashed on incremental build if document uses include directive
### [`v1.7.8`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-178-released-Aug-29-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.7...v1.7.8)
\=====================================
## Incompatible changes
- The type of `env.included` has been changed to dict of set
## Bugs fixed
- [#5320](https://togithub.com/sphinx-doc/sphinx/issues/5320): intersphinx: crashed if invalid url given
- [#5326](https://togithub.com/sphinx-doc/sphinx/issues/5326): manpage: crashed when invalid docname is specified as `man_pages`
- [#5322](https://togithub.com/sphinx-doc/sphinx/issues/5322): autodoc: `Any` typehint causes formatting error
- [#5327](https://togithub.com/sphinx-doc/sphinx/issues/5327): "document isn't included in any toctree" warning on rebuild with
generated files
- [#5335](https://togithub.com/sphinx-doc/sphinx/issues/5335): quickstart: escape sequence has been displayed with MacPorts' python
### [`v1.7.7`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-177-released-Aug-19-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.6...v1.7.7)
\=====================================
## Bugs fixed
- [#5198](https://togithub.com/sphinx-doc/sphinx/issues/5198): document not in toctree warning when including files only for parallel
builds
- LaTeX: reduce "Token not allowed in a PDF string" hyperref warnings in latex
console output (refs: [#5236](https://togithub.com/sphinx-doc/sphinx/issues/5236))
- LaTeX: suppress "remreset Warning: The remreset package is obsolete" in latex
console output with recent LaTeX (refs: [#5237](https://togithub.com/sphinx-doc/sphinx/issues/5237))
- [#5234](https://togithub.com/sphinx-doc/sphinx/issues/5234): PDF output: usage of PAPER environment variable is broken since Sphinx
1.5
- LaTeX: fix the :confval:`latex_engine` documentation regarding Latin Modern
font with XeLaTeX/LuaLateX (refs: [#5251](https://togithub.com/sphinx-doc/sphinx/issues/5251))
- [#5280](https://togithub.com/sphinx-doc/sphinx/issues/5280): autodoc: Fix wrong type annotations for complex typing
- autodoc: Optional types are wrongly rendered
- [#5291](https://togithub.com/sphinx-doc/sphinx/issues/5291): autodoc crashed by ForwardRef types
- [#5211](https://togithub.com/sphinx-doc/sphinx/issues/5211): autodoc: No docs generated for functools.partial functions
- [#5306](https://togithub.com/sphinx-doc/sphinx/issues/5306): autodoc: `getargspec()` raises NameError for invalid typehints
- [#5298](https://togithub.com/sphinx-doc/sphinx/issues/5298): imgmath: math_number_all causes equations to have two numbers in html
- [#5294](https://togithub.com/sphinx-doc/sphinx/issues/5294): sphinx-quickstart blank prompts in PowerShell
### [`v1.7.6`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-176-released-Jul-17-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.5...v1.7.6)
\=====================================
## Bugs fixed
- [#5037](https://togithub.com/sphinx-doc/sphinx/issues/5037): LaTeX `\sphinxupquote{}` breaks in Russian
- sphinx.testing uses deprecated pytest API; `Node.get_marker(name)`
- [#5016](https://togithub.com/sphinx-doc/sphinx/issues/5016): crashed when recommonmark.AutoStrictify is enabled
- [#5022](https://togithub.com/sphinx-doc/sphinx/issues/5022): latex: crashed with Docutils package provided by Debian/Ubuntu
- [#5009](https://togithub.com/sphinx-doc/sphinx/issues/5009): latex: a label for table is vanished if table does not have a caption
- [#5048](https://togithub.com/sphinx-doc/sphinx/issues/5048): crashed with numbered toctree
- [#2410](https://togithub.com/sphinx-doc/sphinx/issues/2410): C, render empty argument lists for macros.
- C++, fix lookup of full template specializations with no template arguments.
- [#4667](https://togithub.com/sphinx-doc/sphinx/issues/4667): C++, fix assertion on missing references in global scope when using
intersphinx. Thanks to Alan M. Carroll.
- [#5019](https://togithub.com/sphinx-doc/sphinx/issues/5019): autodoc: crashed by Form Feed Character
- [#5032](https://togithub.com/sphinx-doc/sphinx/issues/5032): autodoc: loses the first staticmethod parameter for old styled classes
- [#5036](https://togithub.com/sphinx-doc/sphinx/issues/5036): quickstart: Typing Ctrl-U clears the whole of line
- [#5066](https://togithub.com/sphinx-doc/sphinx/issues/5066): html: "relations" sidebar is not shown by default
- [#5091](https://togithub.com/sphinx-doc/sphinx/issues/5091): latex: curly braces in index entries are not handled correctly
- [#5070](https://togithub.com/sphinx-doc/sphinx/issues/5070): epub: Wrong internal href fragment links
- [#5104](https://togithub.com/sphinx-doc/sphinx/issues/5104): apidoc: Interface of `sphinx.apidoc:main()` has changed
- [#4272](https://togithub.com/sphinx-doc/sphinx/issues/4272): PDF builds of French projects have issues with XeTeX
- [#5076](https://togithub.com/sphinx-doc/sphinx/issues/5076): napoleon raises RuntimeError with python 3.7
- [#5125](https://togithub.com/sphinx-doc/sphinx/issues/5125): sphinx-build: Interface of `sphinx:main()` has changed
- sphinx-build: `sphinx.cmd.build.main()` refers `sys.argv` instead of given
argument
- [#5146](https://togithub.com/sphinx-doc/sphinx/issues/5146): autosummary: warning is emitted when the first line of docstring ends
with literal notation
- autosummary: warnings of autosummary indicates wrong location (refs: [#5146](https://togithub.com/sphinx-doc/sphinx/issues/5146))
- [#5143](https://togithub.com/sphinx-doc/sphinx/issues/5143): autodoc: crashed on inspecting dict like object which does not support
sorting
- [#5139](https://togithub.com/sphinx-doc/sphinx/issues/5139): autodoc: Enum argument missing if it shares value with another
- [#4946](https://togithub.com/sphinx-doc/sphinx/issues/4946): py domain: rtype field could not handle "`None`" as a type
- [#5176](https://togithub.com/sphinx-doc/sphinx/issues/5176): LaTeX: indexing of terms containing `@`, `!`, or `"` fails
- [#5161](https://togithub.com/sphinx-doc/sphinx/issues/5161): html: crashes if copying static files are failed
- [#5167](https://togithub.com/sphinx-doc/sphinx/issues/5167): autodoc: Fix formatting type annotations for tuples with more than two
arguments
- [#3329](https://togithub.com/sphinx-doc/sphinx/issues/3329): i18n: crashed by auto-symbol footnote references
- [#5158](https://togithub.com/sphinx-doc/sphinx/issues/5158): autosummary: module summary has been broken when it starts with heading
### [`v1.7.5`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-175-released-May-29-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.4...v1.7.5)
\=====================================
## Bugs fixed
- [#4924](https://togithub.com/sphinx-doc/sphinx/issues/4924): html search: Upper characters problem in any other languages
- [#4932](https://togithub.com/sphinx-doc/sphinx/issues/4932): apidoc: some subpackage is ignored if sibling subpackage contains a
module starting with underscore
- [#4863](https://togithub.com/sphinx-doc/sphinx/issues/4863), [#4938](https://togithub.com/sphinx-doc/sphinx/issues/4938), [#4939](https://togithub.com/sphinx-doc/sphinx/issues/4939): i18n doesn't handle correctly node.title as used for
contents, topic, admonition, table and section.
- [#4913](https://togithub.com/sphinx-doc/sphinx/issues/4913): i18n: literal blocks in bullet list are not translated
- [#4962](https://togithub.com/sphinx-doc/sphinx/issues/4962): C++, raised TypeError on duplicate declaration.
- [#4825](https://togithub.com/sphinx-doc/sphinx/issues/4825): C++, properly parse expr roles and give better error messages when
(escaped) line breaks are present.
- C++, properly use `desc_addname` nodes for prefixes of names.
- C++, parse pack expansions in function calls.
- [#4915](https://togithub.com/sphinx-doc/sphinx/issues/4915), [#4916](https://togithub.com/sphinx-doc/sphinx/issues/4916): links on search page are broken when using dirhtml builder
- [#4969](https://togithub.com/sphinx-doc/sphinx/issues/4969): autodoc: constructor method should not have return annotation
- latex: deeply nested enumerated list which is beginning with non-1 causes
LaTeX engine crashed
- [#4978](https://togithub.com/sphinx-doc/sphinx/issues/4978): latex: shorthandoff is not set up for Brazil locale
- [#4928](https://togithub.com/sphinx-doc/sphinx/issues/4928): i18n: Ignore dot-directories like .git/ in LC_MESSAGES/
- [#4946](https://togithub.com/sphinx-doc/sphinx/issues/4946): py domain: type field could not handle "`None`" as a type
- [#4979](https://togithub.com/sphinx-doc/sphinx/issues/4979): latex: Incorrect escaping of curly braces in index entries
- [#4956](https://togithub.com/sphinx-doc/sphinx/issues/4956): autodoc: Failed to extract document from a subclass of the class on
mocked module
- [#4973](https://togithub.com/sphinx-doc/sphinx/issues/4973): latex: glossary directive adds whitespace to each item
- [#4980](https://togithub.com/sphinx-doc/sphinx/issues/4980): latex: Explicit labels on code blocks are duplicated
- [#4919](https://togithub.com/sphinx-doc/sphinx/issues/4919): node.asdom() crashes if toctree has :numbered: option
- [#4914](https://togithub.com/sphinx-doc/sphinx/issues/4914): autodoc: Parsing error when using dataclasses without default values
- [#4931](https://togithub.com/sphinx-doc/sphinx/issues/4931): autodoc: crashed when handler for autodoc-skip-member raises an error
- [#4931](https://togithub.com/sphinx-doc/sphinx/issues/4931): autodoc: crashed when subclass of mocked class are processed by
napoleon module
- [#5007](https://togithub.com/sphinx-doc/sphinx/issues/5007): sphinx-build crashes when error log contains a "%" character
### [`v1.7.4`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-174-released-Apr-25-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.3...v1.7.4)
\=====================================
## Bugs fixed
- [#4885](https://togithub.com/sphinx-doc/sphinx/issues/4885), [#4887](https://togithub.com/sphinx-doc/sphinx/issues/4887): domains: Crashed with duplicated objects
- [#4889](https://togithub.com/sphinx-doc/sphinx/issues/4889): latex: sphinx.writers.latex causes recursive import
### [`v1.7.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-173-released-Apr-23-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.2...v1.7.3)
\=====================================
## Bugs fixed
- [#4769](https://togithub.com/sphinx-doc/sphinx/issues/4769): autodoc loses the first staticmethod parameter
- [#4790](https://togithub.com/sphinx-doc/sphinx/issues/4790): autosummary: too wide two column tables in PDF builds
- [#4795](https://togithub.com/sphinx-doc/sphinx/issues/4795): Latex customization via `_templates/longtable.tex_t` is broken
- [#4789](https://togithub.com/sphinx-doc/sphinx/issues/4789): imgconverter: confused by convert.exe of Windows
- [#4783](https://togithub.com/sphinx-doc/sphinx/issues/4783): On windows, Sphinx crashed when drives of srcdir and outdir are
different
- [#4812](https://togithub.com/sphinx-doc/sphinx/issues/4812): autodoc ignores type annotated variables
- [#4817](https://togithub.com/sphinx-doc/sphinx/issues/4817): wrong URLs on warning messages
- [#4784](https://togithub.com/sphinx-doc/sphinx/issues/4784): latex: :confval:`latex_show_urls` assigns incorrect footnote numbers if
hyperlinks exists inside substitutions
- [#4837](https://togithub.com/sphinx-doc/sphinx/issues/4837): latex with class memoir Error: Font command `\sf` is not supported
- [#4803](https://togithub.com/sphinx-doc/sphinx/issues/4803): latex: too slow in proportion to number of auto numbered footnotes
- [#4838](https://togithub.com/sphinx-doc/sphinx/issues/4838): htmlhelp: The entries in .hhp file is not ordered
- toctree directive tries to glob for URL having query_string
- [#4871](https://togithub.com/sphinx-doc/sphinx/issues/4871): html search: Upper characters problem in German
- [#4717](https://togithub.com/sphinx-doc/sphinx/issues/4717): latex: Compilation for German docs failed with LuaLaTeX and XeLaTeX
- [#4459](https://togithub.com/sphinx-doc/sphinx/issues/4459): duplicated labels detector does not work well in parallel build
- [#4878](https://togithub.com/sphinx-doc/sphinx/issues/4878): Crashed with extension which returns invalid metadata
### [`v1.7.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-172-released-Mar-21-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.1...v1.7.2)
\=====================================
## Incompatible changes
- [#4520](https://togithub.com/sphinx-doc/sphinx/issues/4520): apidoc: folders with an empty **init**.py are no longer excluded from
TOC
## Bugs fixed
- [#4669](https://togithub.com/sphinx-doc/sphinx/issues/4669): sphinx.build_main and sphinx.make_main throw NameError
- [#4685](https://togithub.com/sphinx-doc/sphinx/issues/4685): autosummary emits meaningless warnings
- autodoc: crashed when invalid options given
- pydomain: always strip parenthesis if empty (refs: [#1042](https://togithub.com/sphinx-doc/sphinx/issues/1042))
- [#4689](https://togithub.com/sphinx-doc/sphinx/issues/4689): autosummary: unexpectedly strips docstrings containing "i.e."
- [#4701](https://togithub.com/sphinx-doc/sphinx/issues/4701): viewcode: Misplaced `
` in viewcode html output
- [#4444](https://togithub.com/sphinx-doc/sphinx/issues/4444): Don't require numfig to use :numref: on sections
- [#4727](https://togithub.com/sphinx-doc/sphinx/issues/4727): Option clash for package textcomp
- [#4725](https://togithub.com/sphinx-doc/sphinx/issues/4725): Sphinx does not work with python 3.5.0 and 3.5.1
- [#4716](https://togithub.com/sphinx-doc/sphinx/issues/4716): Generation PDF file with TexLive on Windows, file not found error
- [#4574](https://togithub.com/sphinx-doc/sphinx/issues/4574): vertical space before equation in latex
- [#4720](https://togithub.com/sphinx-doc/sphinx/issues/4720): message when an image is mismatched for builder is not clear
- [#4655](https://togithub.com/sphinx-doc/sphinx/issues/4655), [#4684](https://togithub.com/sphinx-doc/sphinx/issues/4684): Incomplete localization strings in Polish and Chinese
- [#2286](https://togithub.com/sphinx-doc/sphinx/issues/2286): Sphinx crashes when error is happens in rendering HTML pages
- [#4688](https://togithub.com/sphinx-doc/sphinx/issues/4688): Error to download remote images having long URL
- [#4754](https://togithub.com/sphinx-doc/sphinx/issues/4754): sphinx/pycode/**init**.py raises AttributeError
- [#1435](https://togithub.com/sphinx-doc/sphinx/issues/1435): qthelp builder should htmlescape keywords
- epub: Fix docTitle elements of toc.ncx is not escaped
- [#4520](https://togithub.com/sphinx-doc/sphinx/issues/4520): apidoc: Subpackage not in toc (introduced in 1.6.6) now fixed
- [#4767](https://togithub.com/sphinx-doc/sphinx/issues/4767): html: search highlighting breaks mathjax equations
### [`v1.7.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-171-released-Feb-23-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.0...v1.7.1)
\=====================================
## Deprecated
- [#4623](https://togithub.com/sphinx-doc/sphinx/issues/4623): `sphinx.build_main()` is deprecated.
- autosummary: The interface of `sphinx.ext.autosummary.get_documenter()` has
been changed (Since 1.7.0)
- [#4664](https://togithub.com/sphinx-doc/sphinx/issues/4664): `sphinx.ext.intersphinx.debug()` is deprecated.
For more details, see :ref:`deprecation APIs list `.
## Bugs fixed
- [#4608](https://togithub.com/sphinx-doc/sphinx/issues/4608): epub: Invalid meta tag is generated
- [#4260](https://togithub.com/sphinx-doc/sphinx/issues/4260): autodoc: keyword only argument separator is not disappeared if it is
appeared at top of the argument list
- [#4622](https://togithub.com/sphinx-doc/sphinx/issues/4622): epub: :confval:`epub_scheme` does not effect to content.opf
- [#4627](https://togithub.com/sphinx-doc/sphinx/issues/4627): graphviz: Fit graphviz images to page
- [#4617](https://togithub.com/sphinx-doc/sphinx/issues/4617): quickstart: PROJECT_DIR argument is required
- [#4623](https://togithub.com/sphinx-doc/sphinx/issues/4623): sphinx.build_main no longer exists in 1.7.0
- [#4615](https://togithub.com/sphinx-doc/sphinx/issues/4615): The argument of `sphinx.build` has been changed in 1.7.0
- autosummary: The interface of `sphinx.ext.autosummary.get_documenter()` has
been changed
- [#4630](https://togithub.com/sphinx-doc/sphinx/issues/4630): Have order on msgids in sphinx.pot deterministic
- [#4563](https://togithub.com/sphinx-doc/sphinx/issues/4563): autosummary: Incorrect end of line punctuation detection
- [#4577](https://togithub.com/sphinx-doc/sphinx/issues/4577): Enumerated sublists with explicit start with wrong number
- [#4641](https://togithub.com/sphinx-doc/sphinx/issues/4641): A external link in TOC cannot contain "?" with `:glob:` option
- C++, add missing parsing of explicit casts and typeid in expression parsing.
- C++, add missing parsing of `this` in expression parsing.
- [#4655](https://togithub.com/sphinx-doc/sphinx/issues/4655): Fix incomplete localization strings in Polish
- [#4653](https://togithub.com/sphinx-doc/sphinx/issues/4653): Fix error reporting for parameterless ImportErrors
- [#4664](https://togithub.com/sphinx-doc/sphinx/issues/4664): Reading objects.inv fails again
- [#4662](https://togithub.com/sphinx-doc/sphinx/issues/4662): `any` refs with `term` targets crash when an ambiguity is
encountered
### [`v1.7.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-170-released-Feb-12-2018)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.6.7...v1.7.0)
\=====================================
## Dependencies
1.7.0b1
- Add `packaging` package
## Incompatible changes
1.7.0b1
- [#3668](https://togithub.com/sphinx-doc/sphinx/issues/3668): The arguments has changed of main functions for each command
- [#3893](https://togithub.com/sphinx-doc/sphinx/issues/3893): Unknown html_theme_options throw warnings instead of errors
- [#3927](https://togithub.com/sphinx-doc/sphinx/issues/3927): Python parameter/variable types should match classes, not all objects
- [#3962](https://togithub.com/sphinx-doc/sphinx/issues/3962): sphinx-apidoc now recognizes given directory as an implicit namespace
package when `--implicit-namespaces` option given, not subdirectories of
given directory.
- [#3929](https://togithub.com/sphinx-doc/sphinx/issues/3929): apidoc: Move sphinx.apidoc to sphinx.ext.apidoc
- [#4226](https://togithub.com/sphinx-doc/sphinx/issues/4226): apidoc: Generate new style makefile (make-mode)
- [#4274](https://togithub.com/sphinx-doc/sphinx/issues/4274): sphinx-build returns 2 as an exit code on argument error
- [#4389](https://togithub.com/sphinx-doc/sphinx/issues/4389): output directory will be created after loading extensions
- autodoc does not generate warnings messages to the generated document even if
:confval:`keep_warnings` is `True`. They are only emitted to stderr.
- shebang line is removed from generated conf.py
- [#2557](https://togithub.com/sphinx-doc/sphinx/issues/2557): autodoc: :confval:`autodoc_mock_imports` only mocks specified modules
with their descendants. It does not mock their ancestors. If you want to
mock them, please specify the name of ancestors explicitly.
- [#3620](https://togithub.com/sphinx-doc/sphinx/issues/3620): html theme: move DOCUMENTATION_OPTIONS to independent JavaScript file
(refs: [#4295](https://togithub.com/sphinx-doc/sphinx/issues/4295))
- [#4246](https://togithub.com/sphinx-doc/sphinx/issues/4246): Limit width of text body for all themes. Configurable via theme
options `body_min_width` and `body_max_width`.
- [#4771](https://togithub.com/sphinx-doc/sphinx/issues/4771): apidoc: The `exclude_patterns` arguments are ignored if they are
placed just after command line options
1.7.0b2
- [#4467](https://togithub.com/sphinx-doc/sphinx/issues/4467): html theme: Rename `csss` block to `css`
## Deprecated
1.7.0b1
- using a string value for :confval:`html_sidebars` is deprecated and only list
values will be accepted at 2.0.
- `format_annotation()` and `formatargspec()` is deprecated. Please use
`sphinx.util.inspect.Signature` instead.
- `sphinx.ext.autodoc.AutodocReporter` is replaced by `sphinx.util.docutils.
switch_source_input()` and now deprecated. It will be removed in Sphinx 2.0.
- `sphinx.ext.autodoc.add_documenter()` and `AutoDirective._register` is now
deprecated. Please use `app.add_autodocumenter()` instead.
- `AutoDirective._special_attrgetters` is now deprecated. Please use
`app.add_autodoc_attrgetter()` instead.
## Features added
1.7.0b1
- C++, handle `decltype(auto)`.
- [#2406](https://togithub.com/sphinx-doc/sphinx/issues/2406): C++, add proper parsing of expressions, including linking of
identifiers.
- C++, add a `cpp:expr` role for inserting inline C++ expressions or types.
- C++, support explicit member instantiations with shorthand `template` prefix
- C++, make function parameters linkable, like template params.
- [#3638](https://togithub.com/sphinx-doc/sphinx/issues/3638): Allow to change a label of reference to equation using
`math_eqref_format`
- Now :confval:`suppress_warnings` accepts following configurations:
- `ref.python` (ref: [#3866](https://togithub.com/sphinx-doc/sphinx/issues/3866))
- [#3872](https://togithub.com/sphinx-doc/sphinx/issues/3872): Add latex key to configure literal blocks caption position in PDF
output (refs [#3792](https://togithub.com/sphinx-doc/sphinx/issues/3792), [#1723](https://togithub.com/sphinx-doc/sphinx/issues/1723))
- In case of missing docstring try to retrieve doc from base classes (ref:
[#3140](https://togithub.com/sphinx-doc/sphinx/issues/3140))
- [#4023](https://togithub.com/sphinx-doc/sphinx/issues/4023): Clarify error message when any role has more than one target.
- [#3973](https://togithub.com/sphinx-doc/sphinx/issues/3973): epub: allow to override build date
- [#3972](https://togithub.com/sphinx-doc/sphinx/issues/3972): epub: Sort manifest entries by filename
- [#4052](https://togithub.com/sphinx-doc/sphinx/issues/4052): viewcode: Sort before highlighting module code
- [#1448](https://togithub.com/sphinx-doc/sphinx/issues/1448): qthelp: Add new config value; :confval:`qthelp_namespace`
- [#4140](https://togithub.com/sphinx-doc/sphinx/issues/4140): html themes: Make body tag inheritable
- [#4168](https://togithub.com/sphinx-doc/sphinx/issues/4168): improve zh search with jieba
- HTML themes can set up default sidebars through `theme.conf`
- [#3160](https://togithub.com/sphinx-doc/sphinx/issues/3160): html: Use `` to represent `:kbd:` role
- [#4212](https://togithub.com/sphinx-doc/sphinx/issues/4212): autosummary: catch all exceptions when importing modules
- [#4166](https://togithub.com/sphinx-doc/sphinx/issues/4166): Add :confval:`math_numfig` for equation numbering by section (refs:
[#3991](https://togithub.com/sphinx-doc/sphinx/issues/3991), [#4080](https://togithub.com/sphinx-doc/sphinx/issues/4080)). Thanks to Oliver Jahn.
- [#4311](https://togithub.com/sphinx-doc/sphinx/issues/4311): Let LaTeX obey :confval:`numfig_secnum_depth` for figures, tables, and
code-blocks
- [#947](https://togithub.com/sphinx-doc/sphinx/issues/947): autodoc now supports ignore-module-all to ignore a module's `__all__`
- [#4332](https://togithub.com/sphinx-doc/sphinx/issues/4332): Let LaTeX obey :confval:`math_numfig` for equation numbering
- [#4093](https://togithub.com/sphinx-doc/sphinx/issues/4093): sphinx-build creates e
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 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.4.9->==1.8.6Release Notes
sphinx-doc/sphinx (Sphinx)
### [`v1.8.6`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-186-released-Nov-18-2021) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.5...v1.8.6) \===================================== ## Dependencies - [#9807](https://togithub.com/sphinx-doc/sphinx/issues/9807): Restrict Docutils to 0.17.x or older ### [`v1.8.5`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-185-released-Mar-10-2019) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.4...v1.8.5) \===================================== ## Bugs fixed - LaTeX: Remove extraneous space after author names on PDF title page (refs: [#6004](https://togithub.com/sphinx-doc/sphinx/issues/6004)) - [#6026](https://togithub.com/sphinx-doc/sphinx/issues/6026): LaTeX: A cross reference to definition list does not work - [#6046](https://togithub.com/sphinx-doc/sphinx/issues/6046): LaTeX: `TypeError` is raised when invalid latex_elements given - [#6067](https://togithub.com/sphinx-doc/sphinx/issues/6067): LaTeX: images having a target are concatenated to next line - [#6067](https://togithub.com/sphinx-doc/sphinx/issues/6067): LaTeX: images having a target are not aligned even if specified - [#6149](https://togithub.com/sphinx-doc/sphinx/issues/6149): LaTeX: `:index:` role in titles causes `Use of \@icentercr doesn't match its definition` error on latexpdf build - [#6019](https://togithub.com/sphinx-doc/sphinx/issues/6019): imgconverter: Including multipage PDF fails - [#6047](https://togithub.com/sphinx-doc/sphinx/issues/6047): autodoc: `autofunction` emits a warning for method objects - [#6028](https://togithub.com/sphinx-doc/sphinx/issues/6028): graphviz: Ensure the graphviz filenames are reproducible - [#6068](https://togithub.com/sphinx-doc/sphinx/issues/6068): doctest: `skipif` option may remove the code block from documentation - [#6136](https://togithub.com/sphinx-doc/sphinx/issues/6136): `:name:` option for `math` directive causes a crash - [#6139](https://togithub.com/sphinx-doc/sphinx/issues/6139): intersphinx: ValueError on failure reporting - [#6135](https://togithub.com/sphinx-doc/sphinx/issues/6135): changes: Fix UnboundLocalError when any module found - [#3859](https://togithub.com/sphinx-doc/sphinx/issues/3859): manpage: code-block captions are not displayed correctly ### [`v1.8.4`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-184-released-Feb-03-2019) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.3...v1.8.4) \===================================== ## Bugs fixed - [#3707](https://togithub.com/sphinx-doc/sphinx/issues/3707): latex: no bold checkmark (✔) available. - [#5605](https://togithub.com/sphinx-doc/sphinx/issues/5605): with the documentation language set to Chinese, English words could not be searched. - [#5889](https://togithub.com/sphinx-doc/sphinx/issues/5889): LaTeX: user `numfig_format` is stripped of spaces and may cause build failure - C++, fix hyperlinks for declarations involving east cv-qualifiers. - [#5755](https://togithub.com/sphinx-doc/sphinx/issues/5755): C++, fix duplicate declaration error on function templates with constraints in the return type. - C++, parse unary right fold expressions and binary fold expressions. - pycode could not handle egg files on windows - [#5928](https://togithub.com/sphinx-doc/sphinx/issues/5928): KeyError: 'DOCUTILSCONFIG' when running build - [#5936](https://togithub.com/sphinx-doc/sphinx/issues/5936): LaTeX: PDF build broken by inclusion of image taller than page height in an admonition - [#5231](https://togithub.com/sphinx-doc/sphinx/issues/5231): "make html" does not read and build "po" files in "locale" dir - [#5954](https://togithub.com/sphinx-doc/sphinx/issues/5954): `:scale:` image option may break PDF build if image in an admonition - [#5966](https://togithub.com/sphinx-doc/sphinx/issues/5966): mathjax has not been loaded on incremental build - [#5960](https://togithub.com/sphinx-doc/sphinx/issues/5960): LaTeX: modified PDF layout since September 2018 TeXLive update of :file:`parskip.sty` - [#5948](https://togithub.com/sphinx-doc/sphinx/issues/5948): LaTeX: duplicated labels are generated for sections - [#5958](https://togithub.com/sphinx-doc/sphinx/issues/5958): versionadded directive causes crash with Python 3.5.0 - [#5995](https://togithub.com/sphinx-doc/sphinx/issues/5995): autodoc: autodoc_mock_imports conflict with metaclass on Python 3.7 - [#5871](https://togithub.com/sphinx-doc/sphinx/issues/5871): texinfo: a section title `.` is not allowed ### [`v1.8.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-183-released-Dec-26-2018) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.2...v1.8.3) \===================================== ## Features added - LaTeX: it is possible to insert custom material to appear on back of title page, see discussion of `'maketitle'` key of :confval:`latex_elements` (`'manual'` docclass only) ## Bugs fixed - [#5725](https://togithub.com/sphinx-doc/sphinx/issues/5725): mathjax: Use CDN URL for "latest" version by default - [#5460](https://togithub.com/sphinx-doc/sphinx/issues/5460): html search does not work with some 3rd party themes - [#5520](https://togithub.com/sphinx-doc/sphinx/issues/5520): LaTeX, caption package incompatibility since Sphinx 1.6 - [#5614](https://togithub.com/sphinx-doc/sphinx/issues/5614): autodoc: incremental build is broken when builtin modules are imported - [#5627](https://togithub.com/sphinx-doc/sphinx/issues/5627): qthelp: index.html missing in QtHelp - [#5659](https://togithub.com/sphinx-doc/sphinx/issues/5659): linkcheck: crashes for a hyperlink containing multibyte character - [#5754](https://togithub.com/sphinx-doc/sphinx/issues/5754): DOC: Fix some mistakes in :doc:`/latex` - [#5810](https://togithub.com/sphinx-doc/sphinx/issues/5810): LaTeX: sphinxVerbatim requires explicit "hllines" set-up since 1.6.6 (refs: [#1238](https://togithub.com/sphinx-doc/sphinx/issues/1238)) - [#5636](https://togithub.com/sphinx-doc/sphinx/issues/5636): C++, fix parsing of floating point literals. - [#5496](https://togithub.com/sphinx-doc/sphinx/issues/5496) (again): C++, fix assertion in partial builds with duplicates. - [#5724](https://togithub.com/sphinx-doc/sphinx/issues/5724): quickstart: sphinx-quickstart fails when $LC_ALL is empty - [#1956](https://togithub.com/sphinx-doc/sphinx/issues/1956): Default conf.py is not PEP8-compliant - [#5849](https://togithub.com/sphinx-doc/sphinx/issues/5849): LaTeX: document class `\maketitle` is overwritten with no possibility to use original meaning in place of Sphinx custom one - [#5834](https://togithub.com/sphinx-doc/sphinx/issues/5834): apidoc: wrong help for `--tocfile` - [#5800](https://togithub.com/sphinx-doc/sphinx/issues/5800): todo: crashed if todo is defined in TextElement - [#5846](https://togithub.com/sphinx-doc/sphinx/issues/5846): htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files - htmlhelp: broken .hhk file generated when title contains a double quote ### [`v1.8.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-182-released-Nov-11-2018) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.1...v1.8.2) \===================================== ## Incompatible changes - [#5497](https://togithub.com/sphinx-doc/sphinx/issues/5497): Do not include MathJax.js and jsmath.js unless it is really needed ## Features added - [#5471](https://togithub.com/sphinx-doc/sphinx/issues/5471): Show appropriate deprecation warnings ## Bugs fixed - [#5490](https://togithub.com/sphinx-doc/sphinx/issues/5490): latex: enumerated list causes a crash with recommonmark - [#5492](https://togithub.com/sphinx-doc/sphinx/issues/5492): sphinx-build fails to build docs w/ Python < 3.5.2 - [#3704](https://togithub.com/sphinx-doc/sphinx/issues/3704): latex: wrong `\label` positioning for figures with a legend - [#5496](https://togithub.com/sphinx-doc/sphinx/issues/5496): C++, fix assertion when a symbol is declared more than twice. - [#5493](https://togithub.com/sphinx-doc/sphinx/issues/5493): gettext: crashed with broken template - [#5495](https://togithub.com/sphinx-doc/sphinx/issues/5495): csv-table directive with file option in included file is broken (refs: [#4821](https://togithub.com/sphinx-doc/sphinx/issues/4821)) - [#5498](https://togithub.com/sphinx-doc/sphinx/issues/5498): autodoc: unable to find type hints for a `functools.partial` - [#5480](https://togithub.com/sphinx-doc/sphinx/issues/5480): autodoc: unable to find type hints for unresolvable Forward references - [#5419](https://togithub.com/sphinx-doc/sphinx/issues/5419): incompatible math_block node has been generated - [#5548](https://togithub.com/sphinx-doc/sphinx/issues/5548): Fix ensuredir() in case of pre-existing file - [#5549](https://togithub.com/sphinx-doc/sphinx/issues/5549): graphviz Correctly deal with non-existing static dir - [#3002](https://togithub.com/sphinx-doc/sphinx/issues/3002): i18n: multiple footnote_references referring same footnote cause duplicated node_ids - [#5563](https://togithub.com/sphinx-doc/sphinx/issues/5563): latex: footnote_references generated by extension causes a LaTeX builder crash - [#5561](https://togithub.com/sphinx-doc/sphinx/issues/5561): make all-pdf fails with old xindy version - [#5557](https://togithub.com/sphinx-doc/sphinx/issues/5557): quickstart: --no-batchfile isn't honored - [#3080](https://togithub.com/sphinx-doc/sphinx/issues/3080): texinfo: multiline rubrics are broken - [#3080](https://togithub.com/sphinx-doc/sphinx/issues/3080): texinfo: multiline citations are broken ### [`v1.8.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-181-released-Sep-22-2018) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.8.0...v1.8.1) \===================================== ## Incompatible changes - LaTeX `\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](https://togithub.com/sphinx-doc/sphinx/issues/5455)) ## Bugs fixed - [#5418](https://togithub.com/sphinx-doc/sphinx/issues/5418): Incorrect default path for sphinx-build -d/doctrees files - [#5421](https://togithub.com/sphinx-doc/sphinx/issues/5421): autodoc emits deprecation warning for :confval:`autodoc_default_flags` - [#5422](https://togithub.com/sphinx-doc/sphinx/issues/5422): lambda object causes PicklingError on storing environment - [#5417](https://togithub.com/sphinx-doc/sphinx/issues/5417): Sphinx fails to build with syntax error in Python 2.7.5 - [#4911](https://togithub.com/sphinx-doc/sphinx/issues/4911): add latexpdf to make.bat for non make-mode - [#5436](https://togithub.com/sphinx-doc/sphinx/issues/5436): Autodoc does not work with enum subclasses with properties/methods - [#5437](https://togithub.com/sphinx-doc/sphinx/issues/5437): autodoc: crashed on modules importing eggs - [#5433](https://togithub.com/sphinx-doc/sphinx/issues/5433): latex: ImportError: cannot import name 'DEFAULT_SETTINGS' - [#5431](https://togithub.com/sphinx-doc/sphinx/issues/5431): autodoc: `autofunction` emits a warning for callable objects - [#5457](https://togithub.com/sphinx-doc/sphinx/issues/5457): Fix TypeError in error message when override is prohibited - [#5453](https://togithub.com/sphinx-doc/sphinx/issues/5453): PDF builds of 'howto' documents have no page numbers - [#5463](https://togithub.com/sphinx-doc/sphinx/issues/5463): mathbase: math_role and MathDirective was disappeared in 1.8.0 - [#5454](https://togithub.com/sphinx-doc/sphinx/issues/5454): latex: Index has disappeared from PDF for Japanese documents - [#5432](https://togithub.com/sphinx-doc/sphinx/issues/5432): py domain: `:type:` field can't process `:term:` references - [#5426](https://togithub.com/sphinx-doc/sphinx/issues/5426): py domain: TypeError has been raised for class attribute ### [`v1.8.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-180-released-Sep-13-2018) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v1.7.9...v1.8.0) \===================================== ## Dependencies 1.8.0b1 - LaTeX: :confval:`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](https://togithub.com/sphinx-doc/sphinx/issues/5134)) - LaTeX: `latexmk` is required for `make latexpdf` on Windows ## Incompatible changes 1.8.0b2 - [#5282](https://togithub.com/sphinx-doc/sphinx/issues/5282): html theme: refer `pygments_style` settings of HTML themes preferentially - The URL of download files are changed - [#5127](https://togithub.com/sphinx-doc/sphinx/issues/5127): quickstart: `Makefile` and `make.bat` are not overwritten if exists 1.8.0b1 - [#5156](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/789): `:samp:` role supports to escape curly braces with backslash - [#4811](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/4035)) - [#1857](https://togithub.com/sphinx-doc/sphinx/issues/1857): latex: :confval:`latex_show_pagerefs` does not add pagerefs for citations - [#4648](https://togithub.com/sphinx-doc/sphinx/issues/4648): latex: Now "rubric" elements are rendered as unnumbered section title - [#4983](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/5072): Save environment object also with only new documents - [#5035](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/5134)). After upgrading Sphinx, please clean latex build repertory of existing project before new build. - [#5163](https://togithub.com/sphinx-doc/sphinx/issues/5163): html: hlist items are now aligned to top - `highlightlang` directive is processed on resolving phase - [#4000](https://togithub.com/sphinx-doc/sphinx/issues/4000): LaTeX: template changed. Following elements moved to it: - `\begin{document}` - `shorthandoff` variable - `maketitle` variable - `tableofcontents` variable ## Deprecated 1.8.0b2 - `sphinx.io.SphinxI18nReader.set_lineno_for_reporter()` is deprecated - `sphinx.io.SphinxI18nReader.line` is deprecated - `sphinx.util.i18n.find_catalog_source_file()` has changed; the *gettext_compact* argument has been deprecated - [#5403](https://togithub.com/sphinx-doc/sphinx/issues/5403): `sphinx.util.images.guess_mimetype()` has changed; the *content* argument has been deprecated 1.8.0b1 - :confval:`source_parsers` is deprecated - :confval:`autodoc_default_flags` is deprecated - quickstart: `--epub` option becomes default, so it is deprecated - Drop function based directive support. For now, Sphinx only supports class based directives (see :class:`~docutils.parsers.rst.Directive`) - `sphinx.util.docutils.directive_helper()` is deprecated - `sphinx.cmdline` is deprecated - `sphinx.make_mode` is deprecated - `sphinx.locale.l_()` is deprecated - [#2157](https://togithub.com/sphinx-doc/sphinx/issues/2157): helper function `warn()` for HTML themes is deprecated - `app.override_domain()` is deprecated - `app.add_stylesheet()` is deprecated - `app.add_javascript()` is deprecated - `app.import_object()` is deprecated - `app.add_source_parser()` has changed; the *suffix* argument has been deprecated - `sphinx.versioning.prepare()` is deprecated - `Config.__init__()` has changed; the *dirname*, *filename* and *tags* argument has been deprecated - `Config.check_types()` is deprecated - `Config.check_unicode()` is deprecated - `sphinx.application.CONFIG_FILENAME` is deprecated - `highlightlang` directive is deprecated - `BuildEnvironment.load()` is deprecated - `BuildEnvironment.loads()` is deprecated - `BuildEnvironment.frompickle()` is deprecated - `env.read_doc()` is deprecated - `env.update()` is deprecated - `env._read_serial()` is deprecated - `env._read_parallel()` is deprecated - `env.write_doctree()` is deprecated - `env._nitpick_ignore` is deprecated - `env.versionchanges` is deprecated - `env.dump()` is deprecated - `env.dumps()` is deprecated - `env.topickle()` is deprecated - `env.note_versionchange()` is deprecated - `sphinx.writers.latex.Table.caption_footnotetexts` is deprecated - `sphinx.writers.latex.Table.header_footnotetexts` is deprecated - `sphinx.writers.latex.LaTeXTranslator.footnotestack` is deprecated - `sphinx.writers.latex.LaTeXTranslator.in_container_literal_block` is deprecated - `sphinx.writers.latex.LaTeXTranslator.next_section_ids` is deprecated - `sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids` is deprecated - `sphinx.writers.latex.LaTeXTranslator.restrict_footnote()` is deprecated - `sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()` is deprecated - `sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()` is deprecated - `sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()` is deprecated - `sphinx.writers.latex.LaTeXTranslator.check_latex_elements()` is deprecated - `sphinx.writers.latex.LaTeXTranslator.bibitems` is deprecated - `sphinx.writers.latex.LaTeXTranslator.hlsettingstack` is deprecated - `sphinx.writers.latex.ExtBabel.get_shorthandoff()` is deprecated - `sphinx.writers.html.HTMLTranslator.highlightlang` is deprecated - `sphinx.writers.html.HTMLTranslator.highlightlang_base` is deprecated - `sphinx.writers.html.HTMLTranslator.highlightlangopts` is deprecated - `sphinx.writers.html.HTMLTranslator.highlightlinenothreshold` is deprecated - `sphinx.writers.html5.HTMLTranslator.highlightlang` is deprecated - `sphinx.writers.html5.HTMLTranslator.highlightlang_base` is deprecated - `sphinx.writers.html5.HTMLTranslator.highlightlangopts` is deprecated - `sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold` is deprecated - `sphinx.ext.mathbase` extension is deprecated - `sphinx.ext.mathbase.math` node is deprecated - `sphinx.ext.mathbase.displaymath` node is deprecated - `sphinx.ext.mathbase.eqref` node is deprecated - `sphinx.ext.mathbase.is_in_section_title()` is deprecated - `sphinx.ext.mathbase.MathDomain` is deprecated - `sphinx.ext.mathbase.MathDirective` is deprecated - `sphinx.ext.mathbase.math_role` is deprecated - `sphinx.ext.mathbase.setup_math()` is deprecated - `sphinx.directives.other.VersionChanges` is deprecated - `sphinx.highlighting.PygmentsBridge.unhighlight()` is deprecated - `sphinx.ext.mathbase.get_node_equation_number()` is deprecated - `sphinx.ext.mathbase.wrap_displaymath()` is deprecated - The `trim_doctest_flags` argument of `sphinx.highlighting.PygmentsBridge` is deprecated For more details, see :ref:`deprecation APIs listConfiguration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.