Warning: chmod(): Operation not permitted in /var/www/hopeinstoughton_www/wp-content/plugins/simple-universal-google-analytics/main.php on line 8 [0] in function chmod in /var/www/hopeinstoughton_www/wp-content/plugins/simple-universal-google-analytics/main.php on line 8 [1] in function include_once in /var/www/hopeinstoughton_www/wp-settings.php on line 560 [2] in function require_once in /var/www/hopeinstoughton_www/wp-config.php on line 85 [3] in function require_once in /var/www/hopeinstoughton_www/wp-load.php on line 50 [4] in function require_once in /var/www/hopeinstoughton_www/wp-blog-header.php on line 13 [5] in function require in /var/www/hopeinstoughton_www/index.php on line 17
| Server IP : 94.177.8.99 / Your IP : 216.73.217.165 Web Server : Apache/2.4.58 (Ubuntu) System : Linux aries 6.8.0-134-generic #134-Ubuntu SMP PREEMPT_DYNAMIC Fri Jun 26 18:43:11 UTC 2026 x86_64 User : www-data ( 33) PHP Version : 8.1.34 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /usr/share/doc/sphinx-doc/html/ |
Upload File : |
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Changelog — Sphinx documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=eeb27264" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="_static/sphinx13.css?v=8d8417d5" />
<script src="_static/documentation_options.js?v=63be3e09"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="canonical" href="https://www.sphinx-doc.org/en/master/changes.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Sphinx documentation"
href="_static/opensearch.xml"/>
<link rel="icon" href="_static/favicon.svg"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Projects using Sphinx" href="examples.html" />
<link rel="prev" title="Glossary" href="glossary.html" />
</head><body>
<div class="pageheader">
<a href="index.html">
<img src="_static/sphinxheader.png" alt="SPHINX" />
</a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li><a href="index.html">Documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Changelog</a></li>
</ul>
</div>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div class="sphinxsidebar-navigation__contents">
<h3>On this page</h3>
<ul>
<li><a class="reference internal" href="#">Changelog</a></li>
</ul>
</div>
<div class="sphinxsidebar-navigation__pages">
<h3>Site navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Get started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installing Sphinx</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">Tutorial: Build your first project</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">User Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage/index.html">Using Sphinx</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/index.html">Writing Sphinx Extensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="latex.html">LaTeX customization</a></li>
<li class="toctree-l1"><a class="reference internal" href="extdev/index.html">Sphinx Extensions API</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Community</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="support.html">Get support</a></li>
<li class="toctree-l1"><a class="reference internal" href="internals/index.html">Contribute to Sphinx</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Sphinx FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Sphinx authors</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="man/index.html">Command-Line Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/extensions/index.html">Extensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/restructuredtext/index.html">reStructuredText</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Projects using Sphinx</a></li>
</ul>
</div>
</div>
<div class="body" role="main">
<section id="changelog">
<span id="changes"></span><h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading">¶</a></h1>
<section id="release-7-2-6-released-sep-13-2023">
<h2>Release 7.2.6 (released Sep 13, 2023)<a class="headerlink" href="#release-7-2-6-released-sep-13-2023" title="Link to this heading">¶</a></h2>
<section id="bugs-fixed">
<h3>Bugs fixed<a class="headerlink" href="#bugs-fixed" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11679">#11679</a>: Add the <code class="xref std std-envvar docutils literal notranslate"><span class="pre">SPHINX_AUTODOC_RELOAD_MODULES</span></code> environment variable,
which if set reloads modules when using autodoc with <code class="docutils literal notranslate"><span class="pre">TYPE_CHECKING</span> <span class="pre">=</span> <span class="pre">True</span></code>.
Patch by Matt Wozniski and Adam Turner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11679">#11679</a>: Use <a class="reference external" href="/usr/share/doc/python3-doc/html/library/importlib.html#importlib.reload" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">importlib.reload()</span></code></a> to reload modules in autodoc.
Patch by Matt Wozniski and Adam Turner.</p></li>
</ul>
</section>
</section>
<section id="release-7-2-5-released-aug-30-2023">
<h2>Release 7.2.5 (released Aug 30, 2023)<a class="headerlink" href="#release-7-2-5-released-aug-30-2023" title="Link to this heading">¶</a></h2>
<section id="id3">
<h3>Bugs fixed<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11645">#11645</a>: Fix a regression preventing autodoc from importing modules within
packages that make use of <code class="docutils literal notranslate"><span class="pre">if</span> <span class="pre">typing.TYPE_CHECKING:</span></code> to guard circular
imports needed by type checkers.
Patch by Matt Wozniski.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11634">#11634</a>: Fixed inheritance diagram relative link resolution
for sibling files in a subdirectory.
Patch by Albert Shih.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11659">#11659</a>: Allow <code class="docutils literal notranslate"><span class="pre">?config=...</span></code> in <a class="reference internal" href="usage/extensions/math.html#confval-mathjax_path"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mathjax_path</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11654">#11654</a>: autodoc: Fail with a more descriptive error message
when an object claims to be an instance of <code class="docutils literal notranslate"><span class="pre">type</span></code>,
but is not a class.
Patch by James Braza.</p></li>
<li><p>11620: Cease emitting <a class="reference internal" href="extdev/appapi.html#event-source-read"><code class="xref std std-event docutils literal notranslate"><span class="pre">source-read</span></code></a> events for files read via
the <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#include">include</a> directive.</p></li>
<li><p>11620: Add a new <a class="reference internal" href="extdev/appapi.html#event-include-read"><code class="xref std std-event docutils literal notranslate"><span class="pre">include-read</span></code></a> for observing and transforming
the content of included files via the <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#include">include</a> directive.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11627">#11627</a>: Restore support for copyright lines of the form <code class="docutils literal notranslate"><span class="pre">YYYY</span></code>
when <code class="docutils literal notranslate"><span class="pre">SOURCE_DATE_EPOCH</span></code> is set.</p></li>
</ul>
</section>
</section>
<section id="release-7-2-4-released-aug-28-2023">
<h2>Release 7.2.4 (released Aug 28, 2023)<a class="headerlink" href="#release-7-2-4-released-aug-28-2023" title="Link to this heading">¶</a></h2>
<section id="id9">
<h3>Bugs fixed<a class="headerlink" href="#id9" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11618">#11618</a>: Fix a regression in the MoveModuleTargets transform,
introduced in <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10478">#10478</a> (<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9662">#9662</a>).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11649">#11649</a>: linkcheck: Resolve hanging tests for timezones west of London
and incorrect conversion from UTC to offsets from the UNIX epoch.
Patch by Dmitry Shachnev and Adam Turner.</p></li>
</ul>
</section>
</section>
<section id="release-7-2-3-released-aug-23-2023">
<h2>Release 7.2.3 (released Aug 23, 2023)<a class="headerlink" href="#release-7-2-3-released-aug-23-2023" title="Link to this heading">¶</a></h2>
<section id="dependencies">
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11576">#11576</a>: Require sphinxcontrib-serializinghtml 1.1.9.</p></li>
</ul>
</section>
<section id="id15">
<h3>Bugs fixed<a class="headerlink" href="#id15" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Fix regression in <code class="docutils literal notranslate"><span class="pre">autodoc.Documenter.parse_name()</span></code>.</p></li>
<li><p>Fix regression in JSON serialisation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11543">#11543</a>: autodoc: Support positional-only parameters in <code class="docutils literal notranslate"><span class="pre">classmethod</span></code> methods
when <code class="docutils literal notranslate"><span class="pre">autodoc_preserve_defaults</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
<li><p>Restore support string methods on path objects.
This is deprecated and will be removed in Sphinx 8.
Use <a class="reference external" href="/usr/share/doc/python3-doc/html/library/os.html#os.fspath" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.fspath()</span></code></a> to convert <a class="reference external" href="/usr/share/doc/python3-doc/html/library/pathlib.html#pathlib.Path" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a> objects to strings,
or <a class="reference external" href="/usr/share/doc/python3-doc/html/library/pathlib.html#pathlib.Path" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a>’s methods to work with path objects.</p></li>
</ul>
</section>
</section>
<section id="release-7-2-2-released-aug-17-2023">
<h2>Release 7.2.2 (released Aug 17, 2023)<a class="headerlink" href="#release-7-2-2-released-aug-17-2023" title="Link to this heading">¶</a></h2>
<section id="id17">
<h3>Bugs fixed<a class="headerlink" href="#id17" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Fix the signature of the <code class="docutils literal notranslate"><span class="pre">StateMachine.insert_input()</span></code> patch,
for when calling with keyword arguments.</p></li>
<li><p>Fixed membership testing (<code class="docutils literal notranslate"><span class="pre">in</span></code>) for the <a class="reference external" href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> interface
of the asset classes (<code class="docutils literal notranslate"><span class="pre">_CascadingStyleSheet</span></code> and <code class="docutils literal notranslate"><span class="pre">_JavaScript</span></code>),
which several extensions relied upon.</p></li>
<li><p>Fixed a type error in <code class="docutils literal notranslate"><span class="pre">SingleFileHTMLBuilder._get_local_toctree</span></code>,
<code class="docutils literal notranslate"><span class="pre">includehidden</span></code> may be passed as a string or a boolean.</p></li>
<li><p>Fix <code class="docutils literal notranslate"><span class="pre">:noindex:</span></code> for <code class="docutils literal notranslate"><span class="pre">PyModule</span></code> and <code class="docutils literal notranslate"><span class="pre">JSModule</span></code>.</p></li>
</ul>
</section>
</section>
<section id="release-7-2-1-released-aug-17-2023">
<h2>Release 7.2.1 (released Aug 17, 2023)<a class="headerlink" href="#release-7-2-1-released-aug-17-2023" title="Link to this heading">¶</a></h2>
<section id="id18">
<h3>Bugs fixed<a class="headerlink" href="#id18" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Restored the the <a class="reference external" href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> interface of the asset classes
(<code class="docutils literal notranslate"><span class="pre">_CascadingStyleSheet</span></code> and <code class="docutils literal notranslate"><span class="pre">_JavaScript</span></code>), which several extensions relied upon.
This will be removed in Sphinx 9.</p></li>
<li><p>Restored calls to <code class="docutils literal notranslate"><span class="pre">Builder.add_{css,js}_file()</span></code>,
which several extensions relied upon.</p></li>
<li><p>Restored the private API <code class="docutils literal notranslate"><span class="pre">TocTree.get_toctree_ancestors()</span></code>,
which several extensions relied upon.</p></li>
</ul>
</section>
</section>
<section id="release-7-2-0-released-aug-17-2023">
<h2>Release 7.2.0 (released Aug 17, 2023)<a class="headerlink" href="#release-7-2-0-released-aug-17-2023" title="Link to this heading">¶</a></h2>
<section id="id19">
<h3>Dependencies<a class="headerlink" href="#id19" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11511">#11511</a>: Drop Python 3.8 support.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11576">#11576</a>: Require Pygments 2.14 or later.</p></li>
</ul>
</section>
<section id="deprecated">
<h3>Deprecated<a class="headerlink" href="#deprecated" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11512">#11512</a>: Deprecate <code class="docutils literal notranslate"><span class="pre">sphinx.util.md5</span></code> and <code class="docutils literal notranslate"><span class="pre">sphinx.util.sha1</span></code>.
Use <code class="docutils literal notranslate"><span class="pre">hashlib</span></code> instead.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11526">#11526</a>: Deprecate <code class="docutils literal notranslate"><span class="pre">sphinx.testing.path</span></code>.
Use <code class="docutils literal notranslate"><span class="pre">os.path</span></code> or <code class="docutils literal notranslate"><span class="pre">pathlib</span></code> instead.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11528">#11528</a>: Deprecate <code class="docutils literal notranslate"><span class="pre">sphinx.util.split_index_msg</span></code> and <code class="docutils literal notranslate"><span class="pre">sphinx.util.split_into</span></code>.
Use <code class="docutils literal notranslate"><span class="pre">sphinx.util.index_entries.split_index_msg</span></code> instead.</p></li>
<li><p>Deprecate <code class="docutils literal notranslate"><span class="pre">sphinx.builders.html.Stylesheet</span></code>
and <code class="docutils literal notranslate"><span class="pre">sphinx.builders.html.Javascript</span></code>.
Use <code class="docutils literal notranslate"><span class="pre">sphinx.application.Sphinx.add_css_file()</span></code>
and <code class="docutils literal notranslate"><span class="pre">sphinx.application.Sphinx.add_js_file()</span></code> instead.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11582">#11582</a>: Deprecate <code class="docutils literal notranslate"><span class="pre">sphinx.builders.html.StandaloneHTMLBuilder.css_files</span></code> and
<code class="docutils literal notranslate"><span class="pre">sphinx.builders.html.StandaloneHTMLBuilder.script_files</span></code>.
Use <code class="docutils literal notranslate"><span class="pre">sphinx.application.Sphinx.add_css_file()</span></code>
and <code class="docutils literal notranslate"><span class="pre">sphinx.application.Sphinx.add_js_file()</span></code> instead.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11459">#11459</a>: Deprecate <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.preserve_defaults.get_function_def()</span></code>.
Patch by Bénédikt Tran.</p></li>
</ul>
</section>
<section id="features-added">
<h3>Features added<a class="headerlink" href="#features-added" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11526">#11526</a>: Support <code class="docutils literal notranslate"><span class="pre">os.PathLike</span></code> types and <code class="docutils literal notranslate"><span class="pre">pathlib.Path</span></code> objects
in many more places.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5474">#5474</a>: coverage: Print summary statistics tables.
Patch by Jorge Leitao.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6319">#6319</a>: viewcode: Add <a class="reference internal" href="usage/extensions/viewcode.html#confval-viewcode_line_numbers"><code class="xref std std-confval docutils literal notranslate"><span class="pre">viewcode_line_numbers</span></code></a> to control
whether line numbers are added to rendered source code.
Patch by Ben Krikler.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9662">#9662</a>: Add the <code class="docutils literal notranslate"><span class="pre">:no-typesetting:</span></code> option to suppress textual output
and only create a linkable anchor.
Patch by Latosha Maltba.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11221">#11221</a>: C++: Support domain objects in the table of contents.
Patch by Rouslan Korneychuk.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10938">#10938</a>: doctest: Add <a class="reference internal" href="usage/extensions/doctest.html#confval-doctest_show_successes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">doctest_show_successes</span></code></a> option.
Patch by Trey Hunner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11533">#11533</a>: Add <code class="docutils literal notranslate"><span class="pre">:no-index:</span></code>, <code class="docutils literal notranslate"><span class="pre">:no-index-entry:</span></code>, and <code class="docutils literal notranslate"><span class="pre">:no-contents-entry:</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11572">#11572</a>: Improve <code class="docutils literal notranslate"><span class="pre">debug</span></code> logging of reasons why files are detected as out of
date.
Patch by Eric Larson.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10678">#10678</a>: Emit <a class="reference internal" href="extdev/appapi.html#event-source-read"><code class="xref std std-event docutils literal notranslate"><span class="pre">source-read</span></code></a> events for files read via
the <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#include">include</a> directive.
Patch by Halldor Fannar.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11570">#11570</a>: Use short names when using <span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0585/"><strong>PEP 585</strong></a> built-in generics.
Patch by Riccardo Mori.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11300">#11300</a>: Improve <code class="docutils literal notranslate"><span class="pre">SigElementFallbackTransform</span></code> fallback logic and signature
text elements nodes. See <a class="reference internal" href="extdev/nodes.html"><span class="doc">the documentation</span></a> for more
details.
Patch by Bénédikt Tran.</p></li>
<li><p>Allow running Sphinx with <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">sphinx</span> <span class="pre">build</span> <span class="pre">...</span></code>.</p></li>
</ul>
</section>
<section id="id38">
<h3>Bugs fixed<a class="headerlink" href="#id38" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11077">#11077</a>: graphviz: Fix relative links from within the graph.
Patch by Ralf Grubenmann.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11529">#11529</a>: Line Block in LaTeX builder outputs spurious empty token.
Patch by Adrian Vollmer.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11196">#11196</a>: autosummary: Summary line extraction failed with “e.g.”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10614">#10614</a>: Fixed a number of bugs in inheritance diagrams that resulted in
missing or broken links.
Patch by Albert Shih.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9428">#9428</a>: Exclude substitution definitions when running the <code class="docutils literal notranslate"><span class="pre">gettext</span></code> builder.
Patch by Alvin Wong.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10795">#10795</a>: Raise a descriptive error if <code class="docutils literal notranslate"><span class="pre">graphviz_dot</span></code> is falsy.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11546">#11546</a>: Translated nodes identical to their original text are now marked
with the <code class="docutils literal notranslate"><span class="pre">translated=True</span></code> attribute.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10049">#10049</a>: html: Change “Permalink” to “Link” for title text in link anchors.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4225">#4225</a>: Relax Pygments parsing on lexing failures.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11246">#11246</a>: Allow inline links in the first line of a docstring and one-line
type comments <code class="docutils literal notranslate"><span class="pre">#:</span> <span class="pre">:meta</span> <span class="pre">...:</span></code> when using <a class="reference internal" href="usage/extensions/napoleon.html#module-sphinx.ext.napoleon" title="sphinx.ext.napoleon: Support for NumPy and Google style docstrings"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.napoleon</span></code></a>.
Patch by Bénédikt Tran.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10930">#10930</a>: Highlight all search terms on the search results page.
Patch by Dmitry Shachnev.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11473">#11473</a>: Type annotations containing <a class="reference external" href="/usr/share/doc/python3-doc/html/library/typing.html#typing.Literal" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code></a> enumeration
values now render correctly.
Patch by Bénédikt Tran.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11591">#11591</a>: Fix support for C coverage in <code class="docutils literal notranslate"><span class="pre">sphinx.ext.coverage</span></code> extension.
Patch by Stephen Finucane.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11594">#11594</a>: HTML Theme: Enhancements to horizontal scrolling on smaller
devices in the <code class="docutils literal notranslate"><span class="pre">agogo</span></code> theme.
Patch by Lukas Engelter.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11459">#11459</a>: Fix support for async and lambda functions in
<code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.preserve_defaults</span></code>.
Patch by Bénédikt Tran.</p></li>
</ul>
</section>
<section id="testing">
<h3>Testing<a class="headerlink" href="#testing" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11577">#11577</a>: pytest: Fail tests on “XPASS”.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11577">#11577</a>: pytest: Use “importlib” import mode.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11577">#11577</a>: pytest: Set PYTHONWARNINGS=error.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11577">#11577</a>: pytest: Set strict config and strict markers.</p></li>
</ul>
</section>
</section>
<section id="release-7-1-2-released-aug-02-2023">
<h2>Release 7.1.2 (released Aug 02, 2023)<a class="headerlink" href="#release-7-1-2-released-aug-02-2023" title="Link to this heading">¶</a></h2>
<section id="id58">
<h3>Bugs fixed<a class="headerlink" href="#id58" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11542">#11542</a>: linkcheck: Properly respect <a class="reference internal" href="usage/configuration.html#confval-linkcheck_anchors"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_anchors</span></code></a>
and do not spuriously report failures to validate anchors.
Patch by James Addison.</p></li>
</ul>
</section>
</section>
<section id="release-7-1-1-released-jul-27-2023">
<h2>Release 7.1.1 (released Jul 27, 2023)<a class="headerlink" href="#release-7-1-1-released-jul-27-2023" title="Link to this heading">¶</a></h2>
<section id="id60">
<h3>Bugs fixed<a class="headerlink" href="#id60" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11514">#11514</a>: Fix <code class="docutils literal notranslate"><span class="pre">SOURCE_DATE_EPOCH</span></code> in multi-line copyright footer.
Patch by Bénédikt Tran.</p></li>
</ul>
</section>
</section>
<section id="release-7-1-0-released-jul-24-2023">
<h2>Release 7.1.0 (released Jul 24, 2023)<a class="headerlink" href="#release-7-1-0-released-jul-24-2023" title="Link to this heading">¶</a></h2>
<section id="incompatible-changes">
<h3>Incompatible changes<a class="headerlink" href="#incompatible-changes" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Releases are no longer signed, given the <a class="reference external" href="https://blog.pypi.org/posts/2023-05-23-removing-pgp/">change in PyPI policy</a>.</p>
</li>
</ul>
</section>
<section id="id62">
<h3>Deprecated<a class="headerlink" href="#id62" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11412">#11412</a>: Emit warnings on using a deprecated Python-specific index entry type
(namely, <code class="docutils literal notranslate"><span class="pre">module</span></code>, <code class="docutils literal notranslate"><span class="pre">keyword</span></code>, <code class="docutils literal notranslate"><span class="pre">operator</span></code>, <code class="docutils literal notranslate"><span class="pre">object</span></code>, <code class="docutils literal notranslate"><span class="pre">exception</span></code>,
<code class="docutils literal notranslate"><span class="pre">statement</span></code>, and <code class="docutils literal notranslate"><span class="pre">builtin</span></code>) in the <a class="reference internal" href="usage/restructuredtext/directives.html#directive-index" title="index directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">index</span></code></a> directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id64">
<h3>Features added<a class="headerlink" href="#id64" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11415">#11415</a>: Add a checksum to JavaScript and CSS asset URIs included within
generated HTML, using the CRC32 algorithm.</p></li>
<li><p><a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.require_sphinx" title="sphinx.application.Sphinx.require_sphinx"><code class="xref py py-meth docutils literal notranslate"><span class="pre">require_sphinx()</span></code></a> now allows the version
requirement to be specified as <code class="docutils literal notranslate"><span class="pre">(major,</span> <span class="pre">minor)</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11011">#11011</a>: Allow configuring a line-length limit for object signatures, via
<a class="reference internal" href="usage/configuration.html#confval-maximum_signature_line_length"><code class="xref std std-confval docutils literal notranslate"><span class="pre">maximum_signature_line_length</span></code></a> and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example <a class="reference internal" href="usage/restructuredtext/domains.html#directive-option-py-function-single-line-parameter-list" title="py:function:single-line-parameter-list directive:option"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:function:single-line-parameter-list</span></code></a>.
Patch by Thomas Louf, Adam Turner, and Jean-François B.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10983">#10983</a>: Support for multiline copyright statements in the footer block.
Patch by Stefanie Molin</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.display.status_iterator</span></code> now clears the current line
with ANSI control codes, rather than overprinting with space characters.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11431">#11431</a>: linkcheck: Treat SSL failures as broken links.
Patch by James Addison.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11157">#11157</a>: Keep the <code class="docutils literal notranslate"><span class="pre">translated</span></code> attribute on translated nodes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11451">#11451</a>: Improve the traceback displayed when using <a class="reference internal" href="man/sphinx-build.html#cmdoption-sphinx-build-T"><code class="xref std std-option docutils literal notranslate"><span class="pre">sphinx-build</span> <span class="pre">-T</span></code></a>
in parallel builds. Patch by Bénédikt Tran</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11324">#11324</a>: linkcheck: Use session-basd HTTP requests.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11438">#11438</a>: Add support for the <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-class" title="py:class directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:class</span></code></a> and <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-function" title="py:function directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:function</span></code></a>
directives for PEP 695 (generic classes and functions declarations) and
PEP 696 (default type parameters). Multi-line support (<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11011">#11011</a>) is enabled
for type parameters list and can be locally controlled on object description
directives, e.g., <a class="reference internal" href="usage/restructuredtext/domains.html#directive-option-py-function-single-line-type-parameter-list" title="py:function:single-line-type-parameter-list directive:option"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:function:single-line-type-parameter-list</span></code></a>.
Patch by Bénédikt Tran.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11484">#11484</a>: linkcheck: Allow HTML anchors to be ignored on a per-URL basis
via <a class="reference internal" href="usage/configuration.html#confval-linkcheck_anchors_ignore_for_url"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_anchors_ignore_for_url</span></code></a> while
still checking the validity of the page itself.
Patch by Bénédikt Tran</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1246">#1246</a>: Add translation progress statistics and inspection support,
via a new substitution (<code class="docutils literal notranslate"><span class="pre">|translation</span> <span class="pre">progress|</span></code>) and a new
configuration variable (<a class="reference internal" href="usage/configuration.html#confval-translation_progress_classes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">translation_progress_classes</span></code></a>).
These enable determining the percentage of translated elements within
a document, and the remaining translated and untranslated elements.</p></li>
</ul>
</section>
<section id="id76">
<h3>Bugs fixed<a class="headerlink" href="#id76" title="Link to this heading">¶</a></h3>
<ul>
<li><p>Restored the <code class="docutils literal notranslate"><span class="pre">footnote-reference</span></code> class that has been removed in
the latest (unreleased) version of Docutils.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11486">#11486</a>: Use <span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc8081.html"><strong>RFC 8081</strong></a> font file MIME types in the EPUB builder.
Using the correct MIME type will prevent warnings from <code class="docutils literal notranslate"><span class="pre">epubcheck</span></code>
and will generate a valid EPUB.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11435">#11435</a>: Use microsecond-resolution timestamps for outdated file detection
in <code class="docutils literal notranslate"><span class="pre">BuildEnvironment.get_outdated_files</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11437">#11437</a>: Top-level headings starting with a reStructuredText role
now render properly when <a class="reference internal" href="usage/configuration.html#confval-rst_prolog"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rst_prolog</span></code></a> is set.
Previously, a file starting with the below would have
improperly rendered due to where the prologue text
was inserted into the document.</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="gh">:mod:`lobster` -- The lobster module</span>
<span class="gh">====================================</span>
<span class="cp">...</span>
</pre></div>
</div>
<p>Patch by Bénédikt Tran.</p>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11337">#11337</a>: Fix a <code class="docutils literal notranslate"><span class="pre">MemoryError</span></code> in <code class="docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code> when using <code class="docutils literal notranslate"><span class="pre">None</span></code>
or <code class="docutils literal notranslate"><span class="pre">typing.*</span></code> as inline type references. Patch by Bénédikt Tran (picnixz)</p></li>
</ul>
</section>
<section id="id81">
<h3>Testing<a class="headerlink" href="#id81" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11345">#11345</a>: Always delete <code class="docutils literal notranslate"><span class="pre">docutils.conf</span></code> in test directories when running
<code class="docutils literal notranslate"><span class="pre">SphinxTestApp.cleanup()</span></code>.</p></li>
</ul>
</section>
</section>
<section id="release-7-0-1-released-may-12-2023">
<h2>Release 7.0.1 (released May 12, 2023)<a class="headerlink" href="#release-7-0-1-released-may-12-2023" title="Link to this heading">¶</a></h2>
<section id="id83">
<h3>Dependencies<a class="headerlink" href="#id83" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11411">#11411</a>: Support <a class="reference external" href="https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04">Docutils 0.20</a>. Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id85">
<h3>Bugs fixed<a class="headerlink" href="#id85" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11418">#11418</a>: Clean up remaining references to <code class="docutils literal notranslate"><span class="pre">sphinx.setup_command</span></code>
following the removal of support for setuptools.
Patch by Willem Mulder.</p></li>
</ul>
</section>
</section>
<section id="release-7-0-0-released-apr-29-2023">
<h2>Release 7.0.0 (released Apr 29, 2023)<a class="headerlink" href="#release-7-0-0-released-apr-29-2023" title="Link to this heading">¶</a></h2>
<section id="id87">
<h3>Incompatible changes<a class="headerlink" href="#id87" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11359">#11359</a>: Remove long-deprecated aliases for <code class="docutils literal notranslate"><span class="pre">MecabSplitter</span></code> and
<code class="docutils literal notranslate"><span class="pre">DefaultSplitter</span></code> in <code class="docutils literal notranslate"><span class="pre">sphinx.search.ja</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11360">#11360</a>: Remove deprecated <code class="docutils literal notranslate"><span class="pre">make_old_id</span></code> functions in domain object
description classes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11363">#11363</a>: Remove the Setuptools integration (<code class="docutils literal notranslate"><span class="pre">build_sphinx</span></code> hook in
<code class="docutils literal notranslate"><span class="pre">setup.py</span></code>).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11364">#11364</a>: Remove deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.ext.napoleon.iterators</span></code> module.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11365">#11365</a>: Remove support for the <code class="docutils literal notranslate"><span class="pre">jsdump</span></code> format in <code class="docutils literal notranslate"><span class="pre">sphinx.search</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11366">#11366</a>: Make <code class="docutils literal notranslate"><span class="pre">locale</span></code> a required argument to
<code class="docutils literal notranslate"><span class="pre">sphinx.util.i18n.format_date()</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11370">#11370</a>: Remove deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.util.stemmer</span></code> module.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11371">#11371</a>: Remove deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.pycode.ast.parse()</span></code> function.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11372">#11372</a>: Remove deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.io.read_doc()</span></code> function.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11373">#11373</a>: Removed deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.util.get_matching_files()</span></code> function.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11378">#11378</a>: Remove deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.util.docutils.is_html5_writer_available()</span></code>
function.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11379">#11379</a>: Make the <code class="docutils literal notranslate"><span class="pre">env</span></code> argument to <code class="docutils literal notranslate"><span class="pre">Builder</span></code> subclasses required.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11380">#11380</a>: autosummary: Always emit grouped import exceptions.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11381">#11381</a>: Remove deprecated <code class="docutils literal notranslate"><span class="pre">style</span></code> key for HTML templates.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11382">#11382</a>: Remove deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.docclasses</span></code>
attribute.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11383">#11383</a>: Remove deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.builders.html.html5_ready</span></code> and
<code class="docutils literal notranslate"><span class="pre">sphinx.builders.html.HTMLTranslator</span></code> attributes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11385">#11385</a>: Remove support for HTML 4 output.</p></li>
</ul>
</section>
</section>
<section id="release-6-2-1-released-apr-25-2023">
<h2>Release 6.2.1 (released Apr 25, 2023)<a class="headerlink" href="#release-6-2-1-released-apr-25-2023" title="Link to this heading">¶</a></h2>
<section id="id105">
<h3>Bugs fixed<a class="headerlink" href="#id105" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11355">#11355</a>: Revert the default type of <a class="reference internal" href="usage/configuration.html#confval-nitpick_ignore"><code class="xref std std-confval docutils literal notranslate"><span class="pre">nitpick_ignore</span></code></a> and
<a class="reference internal" href="usage/configuration.html#confval-nitpick_ignore_regex"><code class="xref std std-confval docutils literal notranslate"><span class="pre">nitpick_ignore_regex</span></code></a> to <code class="docutils literal notranslate"><span class="pre">list</span></code>.</p></li>
</ul>
</section>
</section>
<section id="release-6-2-0-released-apr-23-2023">
<h2>Release 6.2.0 (released Apr 23, 2023)<a class="headerlink" href="#release-6-2-0-released-apr-23-2023" title="Link to this heading">¶</a></h2>
<section id="id107">
<h3>Dependencies<a class="headerlink" href="#id107" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Require Docutils 0.18.1 or greater.</p></li>
</ul>
</section>
<section id="id108">
<h3>Incompatible changes<a class="headerlink" href="#id108" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>LaTeX: removal of some internal TeX <code class="docutils literal notranslate"><span class="pre">\dimen</span></code> registers (not previously
publicly documented) as per 5.1.0 code comments in <code class="docutils literal notranslate"><span class="pre">sphinx.sty</span></code>:
<code class="docutils literal notranslate"><span class="pre">\sphinxverbatimsep</span></code>, <code class="docutils literal notranslate"><span class="pre">\sphinxverbatimborder</span></code>, <code class="docutils literal notranslate"><span class="pre">\sphinxshadowsep</span></code>,
<code class="docutils literal notranslate"><span class="pre">\sphinxshadowsize</span></code>, and <code class="docutils literal notranslate"><span class="pre">\sphinxshadowrule</span></code>. (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11105">#11105</a>)</p></li>
<li><p>Remove <code class="docutils literal notranslate"><span class="pre">.egg</span></code> support from pycode <code class="docutils literal notranslate"><span class="pre">ModuleAnalyser</span></code>; Python eggs are a
now-obsolete binary distribution format</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11089">#11089</a>: Remove deprecated code in <code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck</span></code>.
Patch by Daniel Eades</p></li>
<li><p>Remove internal-only <code class="docutils literal notranslate"><span class="pre">sphinx.locale.setlocale</span></code></p></li>
</ul>
</section>
<section id="id111">
<h3>Deprecated<a class="headerlink" href="#id111" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11247">#11247</a>: Deprecate the legacy <code class="docutils literal notranslate"><span class="pre">intersphinx_mapping</span></code> format</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.osutil.cd</span></code> is deprecated in favour of <code class="docutils literal notranslate"><span class="pre">contextlib.chdir</span></code>.</p></li>
</ul>
</section>
<section id="id113">
<h3>Features added<a class="headerlink" href="#id113" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11277">#11277</a>: <a class="reference internal" href="usage/extensions/autodoc.html#directive-autoproperty" title="autoproperty directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">autoproperty</span></code></a> allows the return type to be specified as
a type comment (e.g., <code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">type:</span> <span class="pre">()</span> <span class="pre">-></span> <span class="pre">int</span></code>). Patch by Bénédikt Tran</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10811">#10811</a>: Autosummary: extend <code class="docutils literal notranslate"><span class="pre">__all__</span></code> to imported members for template rendering
when option <code class="docutils literal notranslate"><span class="pre">autosummary_ignore_module_all</span></code> is set to <code class="docutils literal notranslate"><span class="pre">False</span></code>. Patch by
Clement Pinard</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11147">#11147</a>: Add a <code class="docutils literal notranslate"><span class="pre">content_offset</span></code> parameter to <code class="docutils literal notranslate"><span class="pre">nested_parse_with_titles()</span></code>,
allowing for correct line numbers during nested parsing.
Patch by Jeremy Maitin-Shepard</p></li>
<li><p>Update to Unicode CLDR 42</p></li>
<li><p>Add a <code class="docutils literal notranslate"><span class="pre">--jobs</span></code> synonym for <code class="docutils literal notranslate"><span class="pre">-j</span></code>. Patch by Hugo van Kemenade</p></li>
<li><p>LaTeX: a command <code class="docutils literal notranslate"><span class="pre">\sphinxbox</span></code> for styling text elements with a (possibly
rounded) box, optional background color and shadow, has been added.
See <a class="reference internal" href="latex.html#sphinxbox"><span class="std std-ref">The \sphinxbox command</span></a>. (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11224">#11224</a>)</p></li>
<li><p>LaTeX: add <code class="docutils literal notranslate"><span class="pre">\sphinxstylenotetitle</span></code>, …, <code class="docutils literal notranslate"><span class="pre">\sphinxstylewarningtitle</span></code>, …,
for an extra layer of mark-up freeing up <code class="docutils literal notranslate"><span class="pre">\sphinxstrong</span></code> for other uses.
See <a class="reference internal" href="latex.html#latex-macros"><span class="std std-ref">Macros</span></a>. (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11267">#11267</a>)</p></li>
<li><p>LaTeX: <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#note">note</a>, <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#hint">hint</a>, <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#important">important</a> and <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#tip">tip</a> can
now each be styled as the other admonitions, i.e. possibly with a background
color, individual border widths and paddings, possibly rounded corners, and
optional shadow. See <a class="reference internal" href="latex.html#additionalcss"><span class="std std-ref">Additional CSS-like 'sphinxsetup' keys</span></a>. (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11234">#11234</a>)</p></li>
<li><p>LaTeX: admonitions and <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#topic">topic</a> (and
<a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents">contents</a>) directives, and not only
<a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a>, support <code class="docutils literal notranslate"><span class="pre">box-decoration-break=slice</span></code>.</p></li>
<li><p>LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11243">#11243</a>)</p></li>
<li><p>LaTeX: new options <code class="docutils literal notranslate"><span class="pre">noteTextColor</span></code>, <code class="docutils literal notranslate"><span class="pre">noteTeXextras</span></code> et al.
See <a class="reference internal" href="latex.html#additionalcss"><span class="std std-ref">Additional CSS-like 'sphinxsetup' keys</span></a>.</p></li>
<li><p>LaTeX: support elliptical corners in rounded boxes. (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11254">#11254</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11150">#11150</a>: Include source location in highlighting warnings, when lexing fails.
Patch by Jeremy Maitin-Shepard</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11281">#11281</a>: Support for <a class="reference internal" href="usage/extensions/math.html#confval-imgmath_latex"><code class="xref std std-confval docutils literal notranslate"><span class="pre">imgmath_latex</span></code></a> <code class="docutils literal notranslate"><span class="pre">=</span> <span class="pre">'tectonic'</span></code> or
<code class="docutils literal notranslate"><span class="pre">=</span> <span class="pre">'xelatex'</span></code>. Patch by Dimitar Dimitrov</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11109">#11109</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9643">#9643</a>: Add <a class="reference internal" href="usage/configuration.html#confval-python_display_short_literal_types"><code class="xref std std-confval docutils literal notranslate"><span class="pre">python_display_short_literal_types</span></code></a> option for
condensed rendering of <code class="docutils literal notranslate"><span class="pre">Literal</span></code> types.</p></li>
</ul>
</section>
<section id="id126">
<h3>Bugs fixed<a class="headerlink" href="#id126" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11079">#11079</a>: LaTeX: figures with align attribute may disappear and strangely impact
following lists</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11093">#11093</a>: LaTeX: fix “multiply-defined references” PDF build warnings when one or
more reST labels directly precede an <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-module" title="py:module directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:module</span></code></a> or <a class="reference internal" href="usage/extensions/autodoc.html#directive-automodule" title="automodule directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">automodule</span></code></a>
directive. Patch by Bénédikt Tran (picnixz)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11110">#11110</a>: LaTeX: Figures go missing from latex pdf if their files have the same
base name and they use a post transform. Patch by aaron-cooper</p></li>
<li><p>LaTeX: fix potential color leak from shadow to border of rounded boxes, if
shadow color is set but border color is not</p></li>
<li><p>LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames
respective to contents (when using rounded corners)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11235">#11235</a>: LaTeX: added <code class="docutils literal notranslate"><span class="pre">\color</span></code> in topic (or admonition) contents may cause color
leak to the shadow and border at a page break</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11264">#11264</a>: LaTeX: missing space before colon after “Voir aussi” for <a class="reference internal" href="usage/restructuredtext/directives.html#directive-seealso" title="seealso directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">seealso</span></code></a>
directive in French</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11268">#11268</a>: LaTeX: longtable with left alignment breaks out of current list
indentation context in PDF. Thanks to picnixz.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11274">#11274</a>: LaTeX: external links are not properly escaped for <code class="docutils literal notranslate"><span class="pre">\sphinxupquote</span></code>
compatibility</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11147">#11147</a>: Fix source file/line number info in object description content and in
other uses of <code class="docutils literal notranslate"><span class="pre">nested_parse_with_titles</span></code>. Patch by Jeremy Maitin-Shepard.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11192">#11192</a>: Restore correct parallel search index building.
Patch by Jeremy Maitin-Shepard</p></li>
<li><p>Use the new Transifex <code class="docutils literal notranslate"><span class="pre">tx</span></code> client</p></li>
</ul>
</section>
<section id="id136">
<h3>Testing<a class="headerlink" href="#id136" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Fail testing when any Python warnings are emitted</p></li>
<li><p>Migrate remaining <code class="docutils literal notranslate"><span class="pre">unittest.TestCase</span></code> style test functions to pytest style</p></li>
<li><p>Remove tests that rely on setuptools</p></li>
</ul>
</section>
</section>
<section id="release-6-1-3-released-jan-10-2023">
<h2>Release 6.1.3 (released Jan 10, 2023)<a class="headerlink" href="#release-6-1-3-released-jan-10-2023" title="Link to this heading">¶</a></h2>
<section id="id137">
<h3>Bugs fixed<a class="headerlink" href="#id137" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11116">#11116</a>: Reverted to previous Sphinx 5 node copying method</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11117">#11117</a>: Reverted changes to parallel image processing from Sphinx 6.1.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11119">#11119</a>: Supress <code class="docutils literal notranslate"><span class="pre">ValueError</span></code> in the <code class="docutils literal notranslate"><span class="pre">linkcheck</span></code> builder</p></li>
</ul>
</section>
</section>
<section id="release-6-1-2-released-jan-07-2023">
<h2>Release 6.1.2 (released Jan 07, 2023)<a class="headerlink" href="#release-6-1-2-released-jan-07-2023" title="Link to this heading">¶</a></h2>
<section id="id141">
<h3>Bugs fixed<a class="headerlink" href="#id141" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11101">#11101</a>: LaTeX: <code class="docutils literal notranslate"><span class="pre">div.topic_padding</span></code> key of sphinxsetup documented at 5.1.0 was
implemented with name <code class="docutils literal notranslate"><span class="pre">topic_padding</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11099">#11099</a>: LaTeX: <code class="docutils literal notranslate"><span class="pre">shadowrule</span></code> key of sphinxsetup causes PDF build to crash
since Sphinx 5.1.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11096">#11096</a>: LaTeX: <code class="docutils literal notranslate"><span class="pre">shadowsize</span></code> key of sphinxsetup causes PDF build to crash
since Sphinx 5.1.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11095">#11095</a>: LaTeX: shadow of <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#topic">topic</a> and <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents">contents</a>
boxes not in page margin since Sphinx 5.1.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11100">#11100</a>: Fix copying images when running under parallel mode.</p></li>
</ul>
</section>
</section>
<section id="release-6-1-1-released-jan-05-2023">
<h2>Release 6.1.1 (released Jan 05, 2023)<a class="headerlink" href="#release-6-1-1-released-jan-05-2023" title="Link to this heading">¶</a></h2>
<section id="id147">
<h3>Bugs fixed<a class="headerlink" href="#id147" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11091">#11091</a>: Fix <code class="docutils literal notranslate"><span class="pre">util.nodes.apply_source_workaround</span></code> for <code class="docutils literal notranslate"><span class="pre">literal_block</span></code> nodes
with no source information in the node or the node’s parents.</p></li>
</ul>
</section>
</section>
<section id="release-6-1-0-released-jan-05-2023">
<h2>Release 6.1.0 (released Jan 05, 2023)<a class="headerlink" href="#release-6-1-0-released-jan-05-2023" title="Link to this heading">¶</a></h2>
<section id="id149">
<h3>Dependencies<a class="headerlink" href="#id149" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Adopted the <a class="reference external" href="https://github.com/charliermarsh/ruff">Ruff</a> code linter.</p>
</li>
</ul>
</section>
<section id="id150">
<h3>Incompatible changes<a class="headerlink" href="#id150" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10979">#10979</a>: gettext: Removed support for pluralisation in <code class="docutils literal notranslate"><span class="pre">get_translation</span></code>.
This was unused and complicated other changes to <code class="docutils literal notranslate"><span class="pre">sphinx.locale</span></code>.</p></li>
</ul>
</section>
<section id="id152">
<h3>Deprecated<a class="headerlink" href="#id152" title="Link to this heading">¶</a></h3>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util</span></code> functions:</p>
<blockquote>
<div><ul class="simple">
<li><p>Renamed <code class="docutils literal notranslate"><span class="pre">sphinx.util.typing.stringify()</span></code>
to <code class="docutils literal notranslate"><span class="pre">sphinx.util.typing.stringify_annotation()</span></code></p></li>
<li><p>Moved <code class="docutils literal notranslate"><span class="pre">sphinx.util.xmlname_checker()</span></code>
to <code class="docutils literal notranslate"><span class="pre">sphinx.builders.epub3._XML_NAME_PATTERN</span></code></p></li>
</ul>
<p>Moved to <code class="docutils literal notranslate"><span class="pre">sphinx.util.display</span></code>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.status_iterator</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.display_chunk</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.SkipProgressMessage</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.progress_message</span></code></p></li>
</ul>
<p>Moved to <code class="docutils literal notranslate"><span class="pre">sphinx.util.http_date</span></code>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.epoch_to_rfc1123</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.rfc1123_to_epoch</span></code></p></li>
</ul>
<p>Moved to <code class="docutils literal notranslate"><span class="pre">sphinx.util.exceptions</span></code>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.save_traceback</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.format_exception_cut_frames</span></code></p></li>
</ul>
</div></blockquote>
</li>
</ul>
</section>
<section id="id153">
<h3>Features added<a class="headerlink" href="#id153" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Cache doctrees in the build environment during the writing phase.</p></li>
<li><p>Make all writing phase tasks support parallel execution.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11072">#11072</a>: Use PEP 604 (<code class="docutils literal notranslate"><span class="pre">X</span> <span class="pre">|</span> <span class="pre">Y</span></code>) display conventions for <code class="docutils literal notranslate"><span class="pre">typing.Optional</span></code>
and <code class="docutils literal notranslate"><span class="pre">typing.Optional</span></code> types within the Python domain and autodoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10700">#10700</a>: autodoc: Document <code class="docutils literal notranslate"><span class="pre">typing.NewType()</span></code> types as classes rather than
‘data’.</p></li>
<li><p>Cache doctrees between the reading and writing phases.</p></li>
</ul>
</section>
<section id="id156">
<h3>Bugs fixed<a class="headerlink" href="#id156" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10962">#10962</a>: HTML: Fix the multi-word key name lookup table.</p></li>
<li><p>Fixed support for Python 3.12 alpha 3 (changes in the <code class="docutils literal notranslate"><span class="pre">enum</span></code> module).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11069">#11069</a>: HTML Theme: Removed outdated “shortcut” link relation keyword.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10952">#10952</a>: Properly terminate parallel processes on programme interuption.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10988">#10988</a>: Speed up <code class="docutils literal notranslate"><span class="pre">TocTree.resolve()</span></code> through more efficient copying.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6744">#6744</a>: LaTeX: support for seealso directive should be via an environment
to allow styling.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/11074">#11074</a>: LaTeX: Can’t change sphinxnote to use sphinxheavybox starting with
5.1.0</p></li>
</ul>
</section>
</section>
<section id="release-6-0-1-released-jan-05-2023">
<h2>Release 6.0.1 (released Jan 05, 2023)<a class="headerlink" href="#release-6-0-1-released-jan-05-2023" title="Link to this heading">¶</a></h2>
<section id="id163">
<h3>Dependencies<a class="headerlink" href="#id163" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Require Pygments 2.13 or later.</p></li>
</ul>
</section>
<section id="id164">
<h3>Bugs fixed<a class="headerlink" href="#id164" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10944">#10944</a>: imgmath: Fix resolving image paths for files in nested folders.</p></li>
</ul>
</section>
</section>
<section id="release-6-0-0-released-dec-29-2022">
<h2>Release 6.0.0 (released Dec 29, 2022)<a class="headerlink" href="#release-6-0-0-released-dec-29-2022" title="Link to this heading">¶</a></h2>
<section id="id166">
<h3>Dependencies<a class="headerlink" href="#id166" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10468">#10468</a>: Drop Python 3.6 support</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10470">#10470</a>: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and
Docutils 0.17 support. Patch by Adam Turner</p></li>
</ul>
</section>
<section id="id169">
<h3>Incompatible changes<a class="headerlink" href="#id169" title="Link to this heading">¶</a></h3>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7405">#7405</a>: Removed the jQuery and underscore.js JavaScript frameworks.</p>
<p>These frameworks are no longer be automatically injected into themes from
Sphinx 6.0. If you develop a theme or extension that uses the
<code class="docutils literal notranslate"><span class="pre">jQuery</span></code>, <code class="docutils literal notranslate"><span class="pre">$</span></code>, or <code class="docutils literal notranslate"><span class="pre">$u</span></code> global objects, you need to update your
JavaScript to modern standards, or use the mitigation below.</p>
<p>The first option is to use the <a class="reference external" href="https://github.com/sphinx-contrib/jquery/">sphinxcontrib.jquery</a> extension, which has been
developed by the Sphinx team and contributors. To use this, add
<code class="docutils literal notranslate"><span class="pre">sphinxcontrib.jquery</span></code> to the <code class="docutils literal notranslate"><span class="pre">extensions</span></code> list in <code class="docutils literal notranslate"><span class="pre">conf.py</span></code>, or call
<code class="docutils literal notranslate"><span class="pre">app.setup_extension("sphinxcontrib.jquery")</span></code> if you develop a Sphinx theme
or extension.</p>
<p>The second option is to manually ensure that the frameworks are present.
To re-add jQuery and underscore.js, you will need to copy <code class="docutils literal notranslate"><span class="pre">jquery.js</span></code> and
<code class="docutils literal notranslate"><span class="pre">underscore.js</span></code> from <a class="reference external" href="https://github.com/sphinx-doc/sphinx/tree/v5.3.0/sphinx/themes/basic/static">the Sphinx repository</a> to your <code class="docutils literal notranslate"><span class="pre">static</span></code> directory,
and add the following to your <code class="docutils literal notranslate"><span class="pre">layout.html</span></code>:</p>
<div class="highlight-html+jinja notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span>- <span class="k">block</span> <span class="nv">scripts</span> <span class="cp">%}</span>
<span class="p"><</span><span class="nt">script</span> <span class="na">src</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">pathto</span><span class="o">(</span><span class="s1">'_static/jquery.js'</span><span class="o">,</span> <span class="nv">resource</span><span class="o">=</span><span class="kp">True</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
<span class="p"><</span><span class="nt">script</span> <span class="na">src</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">pathto</span><span class="o">(</span><span class="s1">'_static/underscore.js'</span><span class="o">,</span> <span class="nv">resource</span><span class="o">=</span><span class="kp">True</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
<span class="cp">{{</span> <span class="nb">super</span><span class="o">()</span> <span class="cp">}}</span>
<span class="cp">{%</span>- <span class="k">endblock</span> <span class="cp">%}</span>
</pre></div>
</div>
<p>Patch by Adam Turner.</p>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10471">#10471</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10565">#10565</a>: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See
<a class="reference internal" href="extdev/deprecated.html#dev-deprecated-apis"><span class="std std-ref">Deprecated APIs</span></a> for details. Patch by Adam Turner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10901">#10901</a>: C Domain: Remove support for parsing pre-v3 style type directives and
roles. Also remove associated configuration variables <code class="docutils literal notranslate"><span class="pre">c_allow_pre_v3</span></code> and
<code class="docutils literal notranslate"><span class="pre">c_warn_on_allowed_pre_v3</span></code>. Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id174">
<h3>Features added<a class="headerlink" href="#id174" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10924">#10924</a>: LaTeX: adopt better looking defaults for tables and code-blocks.
See <a class="reference internal" href="usage/configuration.html#confval-latex_table_style"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_table_style</span></code></a> and the <code class="docutils literal notranslate"><span class="pre">pre_border-radius</span></code> and
<code class="docutils literal notranslate"><span class="pre">pre_background-TeXcolor</span></code> <a class="reference internal" href="latex.html#additionalcss"><span class="std std-ref">Additional CSS-like 'sphinxsetup' keys</span></a> for the former defaults
and how to re-enact them if desired.</p></li>
</ul>
</section>
<section id="id176">
<h3>Bugs fixed<a class="headerlink" href="#id176" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10984">#10984</a>: LaTeX: Document <a class="reference internal" href="usage/configuration.html#confval-latex_additional_files"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_additional_files</span></code></a> behavior for files
with <code class="docutils literal notranslate"><span class="pre">.tex</span></code> extension.</p></li>
</ul>
</section>
</section>
<section id="release-5-3-0-released-oct-16-2022">
<h2>Release 5.3.0 (released Oct 16, 2022)<a class="headerlink" href="#release-5-3-0-released-oct-16-2022" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10759">#10759</a>: LaTeX: add <a class="reference internal" href="usage/configuration.html#confval-latex_table_style"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_table_style</span></code></a> and support the
<code class="docutils literal notranslate"><span class="pre">'booktabs'</span></code>, <code class="docutils literal notranslate"><span class="pre">'borderless'</span></code>, and <code class="docutils literal notranslate"><span class="pre">'colorrows'</span></code> styles.
(thanks to Stefan Wiehler for initial pull requests <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6666">#6666</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6671">#6671</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10840">#10840</a>: One can cross-reference including an option value like <code class="docutils literal notranslate"><span class="pre">:option:`--module=foobar`</span></code>,
<code class="docutils literal notranslate"><span class="pre">:option:`--module[=foobar]`</span></code> or <code class="docutils literal notranslate"><span class="pre">:option:`--module</span> <span class="pre">foobar`</span></code>.
Patch by Martin Liska.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10881">#10881</a>: autosectionlabel: Record the generated section label to the debug log.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10268">#10268</a>: Correctly URI-escape image filenames.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10887">#10887</a>: domains: Allow sections in all the content of all object description
directives (e.g. <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-function" title="py:function directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:function</span></code></a>). Patch by Adam Turner</p></li>
</ul>
</section>
<section id="release-5-2-3-released-sep-30-2022">
<h2>Release 5.2.3 (released Sep 30, 2022)<a class="headerlink" href="#release-5-2-3-released-sep-30-2022" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10878">#10878</a>: Fix base64 image embedding in <code class="docutils literal notranslate"><span class="pre">sphinx.ext.imgmath</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10886">#10886</a>: Add <code class="docutils literal notranslate"><span class="pre">:nocontentsentry:</span></code> flag and global domain table of contents
entry control option. Patch by Adam Turner</p></li>
</ul>
</section>
<section id="release-5-2-2-released-sep-27-2022">
<h2>Release 5.2.2 (released Sep 27, 2022)<a class="headerlink" href="#release-5-2-2-released-sep-27-2022" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10872">#10872</a>: Restore link targets for autodoc modules to the top of content.
Patch by Dominic Davis-Foster.</p></li>
</ul>
</section>
<section id="release-5-2-1-released-sep-25-2022">
<h2>Release 5.2.1 (released Sep 25, 2022)<a class="headerlink" href="#release-5-2-1-released-sep-25-2022" title="Link to this heading">¶</a></h2>
<section id="id188">
<h3>Bugs fixed<a class="headerlink" href="#id188" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10861">#10861</a>: Always normalise the <code class="docutils literal notranslate"><span class="pre">pycon3</span></code> lexer to <code class="docutils literal notranslate"><span class="pre">pycon</span></code>.</p></li>
<li><p>Fix using <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary</span></code> with modules containing titles in the
module-level docstring.</p></li>
</ul>
</section>
</section>
<section id="release-5-2-0-post0-released-sep-24-2022">
<h2>Release 5.2.0.post0 (released Sep 24, 2022)<a class="headerlink" href="#release-5-2-0-post0-released-sep-24-2022" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Recreated source tarballs for Debian maintainers.</p></li>
</ul>
</section>
<section id="release-5-2-0-released-sep-24-2022">
<h2>Release 5.2.0 (released Sep 24, 2022)<a class="headerlink" href="#release-5-2-0-released-sep-24-2022" title="Link to this heading">¶</a></h2>
<section id="id190">
<h3>Dependencies<a class="headerlink" href="#id190" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10356">#10356</a>: Sphinx now uses declarative metadata with <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> to
create packages, using PyPA’s <code class="docutils literal notranslate"><span class="pre">flit</span></code> project as a build backend. Patch by
Adam Turner.</p></li>
</ul>
</section>
<section id="id192">
<h3>Deprecated<a class="headerlink" href="#id192" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10843">#10843</a>: Support for HTML 4 output. Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id194">
<h3>Features added<a class="headerlink" href="#id194" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10738">#10738</a>: napoleon: Add support for docstring types using ‘of’, like
<code class="docutils literal notranslate"><span class="pre">type</span> <span class="pre">of</span> <span class="pre">type</span></code>. Example: <code class="docutils literal notranslate"><span class="pre">tuple</span> <span class="pre">of</span> <span class="pre">int</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10286">#10286</a>: C++, support requires clauses not just between the template
parameter lists and the declaration.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10755">#10755</a>: linkcheck: Check the source URL of raw directives that use the <code class="docutils literal notranslate"><span class="pre">url</span></code>
option.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10781">#10781</a>: Allow <a class="reference internal" href="usage/restructuredtext/roles.html#role-ref" title="ref role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">ref</span></code></a> role to be used with definitions and fields.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10717">#10717</a>: HTML Search: Increase priority for full title and
subtitle matches in search results</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10718">#10718</a>: HTML Search: Save search result score to the HTML element for debugging</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10673">#10673</a>: Make toctree accept ‘genindex’, ‘modindex’ and ‘search’ docnames</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6316">#6316</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10804">#10804</a>: Add domain objects to the table of contents. Patch by Adam Turner</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6692">#6692</a>: HTML Search: Include explicit <a class="reference internal" href="usage/restructuredtext/directives.html#directive-index" title="index directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">index</span></code></a> directive index entries
in the search index and search results. Patch by Adam Turner</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10816">#10816</a>: imgmath: Allow embedding images in HTML as base64</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10854">#10854</a>: HTML Search: Use browser localstorage for highlight control, stop
storing highlight parameters in URL query strings. Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id207">
<h3>Bugs fixed<a class="headerlink" href="#id207" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10723">#10723</a>: LaTeX: 5.1.0 has made the ‘sphinxsetup’ <code class="docutils literal notranslate"><span class="pre">verbatimwithframe=false</span></code>
become without effect.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10257">#10257</a>: C++, ensure consistent non-specialization template argument
representation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10729">#10729</a>: C++, fix parsing of certain non-type template parameter packs.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10715">#10715</a>: Revert <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10520">#10520</a>: “Fix” use of sidebar classes in <code class="docutils literal notranslate"><span class="pre">agogo.css_t</span></code></p></li>
</ul>
</section>
</section>
<section id="release-5-1-1-released-jul-26-2022">
<h2>Release 5.1.1 (released Jul 26, 2022)<a class="headerlink" href="#release-5-1-1-released-jul-26-2022" title="Link to this heading">¶</a></h2>
<section id="id213">
<h3>Bugs fixed<a class="headerlink" href="#id213" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10701">#10701</a>: Fix ValueError in the new <code class="docutils literal notranslate"><span class="pre">deque</span></code> based <code class="docutils literal notranslate"><span class="pre">sphinx.ext.napolean</span></code>
iterator implementation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10702">#10702</a>: Restore compatability with third-party builders.</p></li>
</ul>
</section>
</section>
<section id="release-5-1-0-released-jul-24-2022">
<h2>Release 5.1.0 (released Jul 24, 2022)<a class="headerlink" href="#release-5-1-0-released-jul-24-2022" title="Link to this heading">¶</a></h2>
<section id="id216">
<h3>Dependencies<a class="headerlink" href="#id216" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10656">#10656</a>: Support <a class="reference external" href="https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05">Docutils 0.19</a>. Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id218">
<h3>Deprecated<a class="headerlink" href="#id218" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10467">#10467</a>: Deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.util.stemmer</span></code> in favour of <code class="docutils literal notranslate"><span class="pre">snowballstemmer</span></code>.
Patch by Adam Turner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9856">#9856</a>: Deprecated <code class="docutils literal notranslate"><span class="pre">sphinx.ext.napoleon.iterators</span></code>.</p></li>
</ul>
</section>
<section id="id221">
<h3>Features added<a class="headerlink" href="#id221" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10444">#10444</a>: html theme: Allow specifying multiple CSS files through the <code class="docutils literal notranslate"><span class="pre">stylesheet</span></code>
setting in <code class="docutils literal notranslate"><span class="pre">theme.conf</span></code> or by setting <code class="docutils literal notranslate"><span class="pre">html_style</span></code> to an iterable of strings.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10366">#10366</a>: std domain: Add support for emphasising placeholders in <a class="reference internal" href="usage/restructuredtext/domains.html#directive-option" title="option directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">option</span></code></a>
directives through a new <a class="reference internal" href="usage/configuration.html#confval-option_emphasise_placeholders"><code class="xref std std-confval docutils literal notranslate"><span class="pre">option_emphasise_placeholders</span></code></a> configuration
option.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10439">#10439</a>: std domain: Use the repr of some variables when displaying warnings,
making whitespace issues easier to identify.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10571">#10571</a>: quickstart: Reduce content in the generated <code class="docutils literal notranslate"><span class="pre">conf.py</span></code> file. Patch by
Pradyun Gedam.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10648">#10648</a>: LaTeX: CSS-named-alike additional <a class="reference internal" href="latex.html#latexsphinxsetup"><span class="std std-ref">‘sphinxsetup’</span></a>
keys allow to configure four separate border-widths, four paddings, four
corner radii, a shadow (possibly inset), colours for border, background, shadow
for each of the code-block, topic, attention, caution, danger, error and warning
directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10655">#10655</a>: LaTeX: Explain non-standard encoding in LatinRules.xdy</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10599">#10599</a>: HTML Theme: Wrap consecutive footnotes in an <code class="docutils literal notranslate"><span class="pre"><aside></span></code> element when
using Docutils 0.18 or later, to allow for easier styling. This matches the
behaviour introduced in Docutils 0.19. Patch by Adam Turner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10518">#10518</a>: config: Add <code class="docutils literal notranslate"><span class="pre">include_patterns</span></code> as the opposite of <code class="docutils literal notranslate"><span class="pre">exclude_patterns</span></code>.
Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id230">
<h3>Bugs fixed<a class="headerlink" href="#id230" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10594">#10594</a>: HTML Theme: field term colons are doubled if using Docutils 0.18+</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10596">#10596</a>: Build failure if Docutils version is 0.18 (not 0.18.1) due
to missing <code class="docutils literal notranslate"><span class="pre">Node.findall()</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10506">#10506</a>: LaTeX: build error if highlighting inline code role in figure caption
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10251">#10251</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10634">#10634</a>: Make -P (pdb) option work better with exceptions triggered from events</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10550">#10550</a>: py domain: Fix spurious whitespace in unparsing various operators (<code class="docutils literal notranslate"><span class="pre">+</span></code>,
<code class="docutils literal notranslate"><span class="pre">-</span></code>, <code class="docutils literal notranslate"><span class="pre">~</span></code>, and <code class="docutils literal notranslate"><span class="pre">**</span></code>). Patch by Adam Turner (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10551">#10551</a>).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10460">#10460</a>: logging: Always show node source locations as absolute paths.</p></li>
<li><p>HTML Search: HTML tags are displayed as a part of object name</p></li>
<li><p>HTML Search: search snipets should not be folded</p></li>
<li><p>HTML Search: Minor errors are emitted on fetching search snipets</p></li>
<li><p>HTML Search: The markers for header links are shown in the search result</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10520">#10520</a>: HTML Theme: Fix use of sidebar classes in <code class="docutils literal notranslate"><span class="pre">agogo.css_t</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6679">#6679</a>: HTML Theme: Fix inclusion of hidden toctrees in the agogo theme.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10566">#10566</a>: HTML Theme: Fix enable_search_shortcuts does not work</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8686">#8686</a>: LaTeX: Text can fall out of code-block at end of page and leave artifact
on next page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10633">#10633</a>: LaTeX: user injected <code class="docutils literal notranslate"><span class="pre">\color</span></code> commands in topic or admonition boxes may
cause color leaks in PDF due to upstream <a class="reference external" href="https://ctan.org/pkg/framed">framed.sty</a>
bug</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10638">#10638</a>: LaTeX: framed coloured boxes in highlighted code (e.g. highlighted
diffs using Pygments style <code class="docutils literal notranslate"><span class="pre">'manni'</span></code>) inherit thickness of code-block frame</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10647">#10647</a>: LaTeX: Only one <code class="docutils literal notranslate"><span class="pre">\label</span></code> is generated for <code class="docutils literal notranslate"><span class="pre">desc_signature</span></code> node
even if it has multiple node IDs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10579">#10579</a>: i18n: UnboundLocalError is raised on translating raw directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9577">#9577</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10088">#10088</a>: py domain: Fix warning for duplicate Python references when
using <code class="docutils literal notranslate"><span class="pre">:any:</span></code> and autodoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10548">#10548</a>: HTML Search: fix minor summary issues.</p></li>
</ul>
</section>
</section>
<section id="release-5-0-2-released-jun-17-2022">
<h2>Release 5.0.2 (released Jun 17, 2022)<a class="headerlink" href="#release-5-0-2-released-jun-17-2022" title="Link to this heading">¶</a></h2>
<section id="id250">
<h3>Features added<a class="headerlink" href="#id250" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10523">#10523</a>: HTML Theme: Expose the Docutils’s version info tuple as a template
variable, <code class="docutils literal notranslate"><span class="pre">docutils_version_info</span></code>. Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id252">
<h3>Bugs fixed<a class="headerlink" href="#id252" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10538">#10538</a>: autodoc: Inherited class attribute having docstring is documented even
if <code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_inherit_docstring</span></code> is disabled</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10509">#10509</a>: autosummary: autosummary fails with a shared library</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10497">#10497</a>: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10523">#10523</a>: HTML Theme: Fix double brackets on citation references in Docutils 0.18+.
Patch by Adam Turner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10534">#10534</a>: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.</p></li>
</ul>
</section>
</section>
<section id="release-5-0-1-released-jun-03-2022">
<h2>Release 5.0.1 (released Jun 03, 2022)<a class="headerlink" href="#release-5-0-1-released-jun-03-2022" title="Link to this heading">¶</a></h2>
<section id="id258">
<h3>Bugs fixed<a class="headerlink" href="#id258" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10498">#10498</a>: gettext: TypeError is raised when sorting warning messages if a node
has no line number. Patch by Adam Turner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10493">#10493</a>: HTML Theme: <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#topic">topic</a> directive is rendered incorrectly with
Docutils 0.18. Patch by Adam Turner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10495">#10495</a>: IndexError is raised for a <a class="reference internal" href="usage/restructuredtext/roles.html#role-kbd" title="kbd role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">kbd</span></code></a> role having a separator.
Patch by Adam Turner.</p></li>
</ul>
</section>
</section>
<section id="release-5-0-0-released-may-30-2022">
<h2>Release 5.0.0 (released May 30, 2022)<a class="headerlink" href="#release-5-0-0-released-may-30-2022" title="Link to this heading">¶</a></h2>
<section id="id262">
<h3>Dependencies<a class="headerlink" href="#id262" title="Link to this heading">¶</a></h3>
<p>5.0.0 b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10164">#10164</a>: Support <a class="reference external" href="https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26">Docutils 0.18</a>. Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id264">
<h3>Incompatible changes<a class="headerlink" href="#id264" title="Link to this heading">¶</a></h3>
<p>5.0.0 b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10031">#10031</a>: autosummary: <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.import_by_name()</span></code> now raises
<code class="docutils literal notranslate"><span class="pre">ImportExceptionGroup</span></code> instead of <code class="docutils literal notranslate"><span class="pre">ImportError</span></code> when it failed to import
target object. Please handle the exception if your extension uses the
function to import Python object. As a workaround, you can disable the
behavior via <code class="docutils literal notranslate"><span class="pre">grouped_exception=False</span></code> keyword argument until v7.0.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9962">#9962</a>: texinfo: Customizing styles of emphasized text via <code class="docutils literal notranslate"><span class="pre">@definfoenclose</span></code>
command was not supported because the command was deprecated since texinfo 6.8</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2068">#2068</a>: <a class="reference internal" href="usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">intersphinx_disabled_reftypes</span></code></a> has changed default value
from an empty list to <code class="docutils literal notranslate"><span class="pre">['std:doc']</span></code> as avoid too surprising silent
intersphinx resolutions.
To migrate: either add an explicit inventory name to the references
intersphinx should resolve, or explicitly set the value of this configuration
variable to an empty list.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10197">#10197</a>: html theme: Reduce <code class="docutils literal notranslate"><span class="pre">body_min_width</span></code> setting in basic theme to 360px</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9999">#9999</a>: LaTeX: separate terms from their definitions by a CR (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9985">#9985</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10062">#10062</a>: Change the default language to <code class="docutils literal notranslate"><span class="pre">'en'</span></code> if any language is not set in
<code class="docutils literal notranslate"><span class="pre">conf.py</span></code></p></li>
</ul>
<p>5.0.0 final</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10474">#10474</a>: <a class="reference internal" href="usage/configuration.html#confval-language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">language</span></code></a> does not accept <code class="docutils literal notranslate"><span class="pre">None</span></code> as it value. The default
value of <code class="docutils literal notranslate"><span class="pre">language</span></code> becomes to <code class="docutils literal notranslate"><span class="pre">'en'</span></code> now.
Patch by Adam Turner and Takeshi KOMIYA.</p></li>
</ul>
</section>
<section id="id273">
<h3>Deprecated<a class="headerlink" href="#id273" title="Link to this heading">¶</a></h3>
<p>5.0.0 b1</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10028">#10028</a>: jQuery and underscore.js will no longer be automatically injected into
themes from Sphinx 6.0. If you develop a theme or extension that uses the
<code class="docutils literal notranslate"><span class="pre">jQuery</span></code>, <code class="docutils literal notranslate"><span class="pre">$</span></code>, or <code class="docutils literal notranslate"><span class="pre">$u</span></code> global objects, you need to update your
JavaScript or use the mitigation below.</p>
<p>To re-add jQuery and underscore.js, you will need to copy <code class="docutils literal notranslate"><span class="pre">jquery.js</span></code> and
<code class="docutils literal notranslate"><span class="pre">underscore.js</span></code> from <a class="reference external" href="https://github.com/sphinx-doc/sphinx/tree/v5.3.0/sphinx/themes/basic/static">the Sphinx repository</a> to your <code class="docutils literal notranslate"><span class="pre">static</span></code> directory,
and add the following to your <code class="docutils literal notranslate"><span class="pre">layout.html</span></code>:</p>
<div class="highlight-html+jinja notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span>- <span class="k">block</span> <span class="nv">scripts</span> <span class="cp">%}</span>
<span class="p"><</span><span class="nt">script</span> <span class="na">src</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">pathto</span><span class="o">(</span><span class="s1">'_static/jquery.js'</span><span class="o">,</span> <span class="nv">resource</span><span class="o">=</span><span class="kp">True</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
<span class="p"><</span><span class="nt">script</span> <span class="na">src</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">pathto</span><span class="o">(</span><span class="s1">'_static/underscore.js'</span><span class="o">,</span> <span class="nv">resource</span><span class="o">=</span><span class="kp">True</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
<span class="cp">{{</span> <span class="nb">super</span><span class="o">()</span> <span class="cp">}}</span>
<span class="cp">{%</span>- <span class="k">endblock</span> <span class="cp">%}</span>
</pre></div>
</div>
<p>Patch by Adam Turner.</p>
</li>
<li><p>setuptools integration. The <code class="docutils literal notranslate"><span class="pre">build_sphinx</span></code> sub-command for setup.py is
marked as deprecated to follow the policy of setuptools team.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">locale</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.util.i18n:babel_format_date()</span></code> becomes
required</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">language</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.util.i18n:format_date()</span></code> becomes
required</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.html.html5_ready</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.read_doc()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.docutils.__version_info__</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.docutils.is_html5_writer_available()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXWriter.docclasses</span></code></p></li>
</ul>
</section>
<section id="id275">
<h3>Features added<a class="headerlink" href="#id275" title="Link to this heading">¶</a></h3>
<p>5.0.0 b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9075">#9075</a>: autodoc: The default value of <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints_format"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints_format</span></code></a> is
changed to <code class="docutils literal notranslate"><span class="pre">'smart'</span></code>. It will suppress the leading module names of
typehints (ex. <code class="docutils literal notranslate"><span class="pre">io.StringIO</span></code> -> <code class="docutils literal notranslate"><span class="pre">StringIO</span></code>).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8417">#8417</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">:inherited-members:</span></code> option now takes multiple classes. It
allows to suppress inherited members of several classes on the module at once
by specifying the option to <a class="reference internal" href="usage/extensions/autodoc.html#directive-automodule" title="automodule directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">automodule</span></code></a> directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9792">#9792</a>: autodoc: Add new option for <code class="docutils literal notranslate"><span class="pre">autodoc_typehints_description_target</span></code> to
include undocumented return values but not undocumented parameters.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10285">#10285</a>: autodoc: singledispatch functions having typehints are not documented</p></li>
<li><p>autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints_format"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints_format</span></code></a> now also applies to attributes,
data, properties, and type variable bounds.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10258">#10258</a>: autosummary: Recognize a documented attribute of a module as
non-imported</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10028">#10028</a>: Removed internal usages of JavaScript frameworks (jQuery and
underscore.js) and modernised <code class="docutils literal notranslate"><span class="pre">doctools.js</span></code> and <code class="docutils literal notranslate"><span class="pre">searchtools.js</span></code> to
EMCAScript 2018. Patch by Adam Turner.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10302">#10302</a>: C++, add support for conditional expressions (<code class="docutils literal notranslate"><span class="pre">?:</span></code>).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5157">#5157</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10251">#10251</a>: Inline code is able to be highlighted via <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#role">role</a>
directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10337">#10337</a>: Make sphinx-build faster by caching Publisher object during build.
Patch by Adam Turner.</p></li>
</ul>
</section>
<section id="id286">
<h3>Bugs fixed<a class="headerlink" href="#id286" title="Link to this heading">¶</a></h3>
<p>5.0.0 b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10200">#10200</a>: apidoc: Duplicated submodules are shown for modules having both .pyx
and .so files. Patch by Adam Turner and Takeshi KOMIYA.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10279">#10279</a>: autodoc: Default values for keyword only arguments in overloaded
functions are rendered as a string literal</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10280">#10280</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_docstring_signature"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_docstring_signature</span></code></a> unexpectedly generates
return value typehint for constructors if docstring has multiple signatures</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10266">#10266</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_preserve_defaults"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_preserve_defaults</span></code></a> does not work for
mixture of keyword only arguments with/without defaults</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10310">#10310</a>: autodoc: class methods are not documented when decorated with mocked
function</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10305">#10305</a>: autodoc: Failed to extract optional forward-ref’ed typehints correctly
via <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_type_aliases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_type_aliases</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10421">#10421</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_preserve_defaults"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_preserve_defaults</span></code></a> doesn’t work on class
methods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10214">#10214</a>: html: invalid language tag was generated if <a class="reference internal" href="usage/configuration.html#confval-language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">language</span></code></a>
contains a country code (ex. zh_CN)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9974">#9974</a>: html: Updated jQuery version from 3.5.1 to 3.6.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10236">#10236</a>: html search: objects are duplicated in search result</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9962">#9962</a>: texinfo: Deprecation message for <code class="docutils literal notranslate"><span class="pre">@definfoenclose</span></code> command on
bulding texinfo document</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10000">#10000</a>: LaTeX: glossary terms with common definition are rendered with
too much vertical whitespace</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10188">#10188</a>: LaTeX: alternating multiply referred footnotes produce a <code class="docutils literal notranslate"><span class="pre">?</span></code> in
pdf output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10363">#10363</a>: LaTeX: make <code class="docutils literal notranslate"><span class="pre">'howto'</span></code> title page rule use <code class="docutils literal notranslate"><span class="pre">\linewidth</span></code> for
compatibility with usage of a <code class="docutils literal notranslate"><span class="pre">twocolumn</span></code> class option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10318">#10318</a>: <code class="docutils literal notranslate"><span class="pre">:prepend:</span></code> option of <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> directive does not
work with <code class="docutils literal notranslate"><span class="pre">:dedent:</span></code> option</p></li>
</ul>
<p>5.0.0 final</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9575">#9575</a>: autodoc: The annotation of return value should not be shown when
<code class="docutils literal notranslate"><span class="pre">autodoc_typehints="description"</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9648">#9648</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">*args</span></code> and <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> entries are duplicated when
<code class="docutils literal notranslate"><span class="pre">autodoc_typehints="description"</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8180">#8180</a>: autodoc: Docstring metadata ignored for attributes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10443">#10443</a>: epub: EPUB builder can’t detect the mimetype of .webp file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10104">#10104</a>: gettext: Duplicated locations are shown if 3rd party extension does
not provide correct information</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10456">#10456</a>: py domain: <code class="docutils literal notranslate"><span class="pre">:meta:</span></code> fields are displayed if docstring contains two
or more meta-field</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9096">#9096</a>: sphinx-build: the value of progress bar for paralle build is wrong</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10110">#10110</a>: sphinx-build: exit code is not changed when error is raised on
builder-finished event</p></li>
</ul>
</section>
</section>
<section id="release-4-5-0-released-mar-28-2022">
<h2>Release 4.5.0 (released Mar 28, 2022)<a class="headerlink" href="#release-4-5-0-released-mar-28-2022" title="Link to this heading">¶</a></h2>
<section id="id310">
<h3>Incompatible changes<a class="headerlink" href="#id310" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10112">#10112</a>: extlinks: Disable hardcoded links detector by default</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9993">#9993</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10177">#10177</a>: std domain: Disallow to refer an inline target via
<a class="reference internal" href="usage/restructuredtext/roles.html#role-ref" title="ref role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">ref</span></code></a> role</p></li>
</ul>
</section>
<section id="id314">
<h3>Deprecated<a class="headerlink" href="#id314" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()</span></code></p></li>
</ul>
</section>
<section id="id315">
<h3>Features added<a class="headerlink" href="#id315" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10260">#10260</a>: Enable <code class="docutils literal notranslate"><span class="pre">FORCE_COLOR</span></code> and <code class="docutils literal notranslate"><span class="pre">NO_COLOR</span></code> for terminal colouring</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10234">#10234</a>: autosummary: Add “autosummary” CSS class to summary tables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10125">#10125</a>: extlinks: Improve suggestion message for a reference having title</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10112">#10112</a>: extlinks: Add <a class="reference internal" href="usage/extensions/extlinks.html#confval-extlinks_detect_hardcoded_links"><code class="xref std std-confval docutils literal notranslate"><span class="pre">extlinks_detect_hardcoded_links</span></code></a> to enable
hardcoded links detector feature</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9494">#9494</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9456">#9456</a>: html search: Add a config variable
<a class="reference internal" href="usage/configuration.html#confval-html_show_search_summary"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_show_search_summary</span></code></a> to enable/disable the search summaries</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9337">#9337</a>: HTML theme, add option <code class="docutils literal notranslate"><span class="pre">enable_search_shortcuts</span></code> that enables <kbd class="kbd docutils literal notranslate">/</kbd> as
a Quick search shortcut and <kbd class="kbd docutils literal notranslate">Esc</kbd> shortcut that
removes search highlighting.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10107">#10107</a>: i18n: Allow to suppress translation warnings by adding <code class="docutils literal notranslate"><span class="pre">#noqa</span></code>
comment to the tail of each translation message</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10252">#10252</a>: C++, support attributes on classes, unions, and enums.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10253">#10253</a>: <a class="reference internal" href="usage/restructuredtext/roles.html#role-pep" title="pep role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">pep</span></code></a> role now generates URLs based on <a class="reference external" href="https://peps.python.org">peps.python.org</a></p></li>
</ul>
</section>
<section id="id326">
<h3>Bugs fixed<a class="headerlink" href="#id326" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9876">#9876</a>: autodoc: Failed to document an imported class that is built from native
binary module</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10133">#10133</a>: autodoc: Crashed when mocked module is used for type annotation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10146">#10146</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_default_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_default_options</span></code></a> does not support
<code class="docutils literal notranslate"><span class="pre">no-value</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9971">#9971</a>: autodoc: TypeError is raised when the target object is annotated by
unhashable object</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10205">#10205</a>: extlinks: Failed to compile regexp on checking hardcoded links</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10277">#10277</a>: html search: Could not search short words (ex. “use”)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9529">#9529</a>: LaTeX: named auto numbered footnote (ex. <code class="docutils literal notranslate"><span class="pre">[#named]</span></code>) that is referred
multiple times was rendered to a question mark</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9924">#9924</a>: LaTeX: multi-line <a class="reference internal" href="usage/restructuredtext/domains.html#directive-cpp-function" title="cpp:function directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">cpp:function</span></code></a> directive has big vertical
spacing in Latexpdf</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10158">#10158</a>: LaTeX: excessive whitespace since v4.4.0 for undocumented
variables/structure members</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10175">#10175</a>: LaTeX: named footnote reference is linked to an incorrect footnote if
the name is also used in the different document</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10269">#10269</a>: manpage: Failed to resolve the title of <a class="reference internal" href="usage/restructuredtext/roles.html#role-ref" title="ref role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">ref</span></code></a> cross references</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10179">#10179</a>: i18n: suppress “rST localization” warning</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10118">#10118</a>: imgconverter: Unnecessary availablity check is called for remote URIs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10181">#10181</a>: napoleon: attributes are displayed like class attributes for google
style docstrings when <a class="reference internal" href="usage/extensions/napoleon.html#confval-napoleon_use_ivar"><code class="xref std std-confval docutils literal notranslate"><span class="pre">napoleon_use_ivar</span></code></a> is enabled</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10122">#10122</a>: sphinx-build: make.bat does not check the installation of sphinx-build
command before showing help</p></li>
</ul>
</section>
</section>
<section id="release-4-4-0-released-jan-17-2022">
<h2>Release 4.4.0 (released Jan 17, 2022)<a class="headerlink" href="#release-4-4-0-released-jan-17-2022" title="Link to this heading">¶</a></h2>
<section id="id342">
<h3>Dependencies<a class="headerlink" href="#id342" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10007">#10007</a>: Use <code class="docutils literal notranslate"><span class="pre">importlib_metadata</span></code> for python-3.9 or older</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10007">#10007</a>: Drop <code class="docutils literal notranslate"><span class="pre">setuptools</span></code></p></li>
</ul>
</section>
<section id="id345">
<h3>Features added<a class="headerlink" href="#id345" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9075">#9075</a>: autodoc: Add a config variable <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints_format"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints_format</span></code></a>
to suppress the leading module names of typehints of function signatures (ex.
<code class="docutils literal notranslate"><span class="pre">io.StringIO</span></code> -> <code class="docutils literal notranslate"><span class="pre">StringIO</span></code>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9831">#9831</a>: Autosummary now documents only the members specified in a module’s
<code class="docutils literal notranslate"><span class="pre">__all__</span></code> attribute if <a class="reference internal" href="usage/extensions/autosummary.html#confval-autosummary_ignore_module_all"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosummary_ignore_module_all</span></code></a> is set to
<code class="docutils literal notranslate"><span class="pre">False</span></code>. The default behaviour is unchanged. Autogen also now supports
this behavior with the <code class="docutils literal notranslate"><span class="pre">--respect-module-all</span></code> switch.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9555">#9555</a>: autosummary: Improve error messages on failure to load target object</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9800">#9800</a>: extlinks: Emit warning if a hardcoded link is replaceable
by an extlink, suggesting a replacement.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9961">#9961</a>: html: Support nested <kbd> HTML elements in other HTML builders</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10013">#10013</a>: html: Allow to change the loading method of JS via <code class="docutils literal notranslate"><span class="pre">loading_method</span></code>
parameter for <a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.add_js_file" title="sphinx.application.Sphinx.add_js_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Sphinx.add_js_file()</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9551">#9551</a>: html search: “Hide Search Matches” link removes “highlight” parameter
from URL</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9815">#9815</a>: html theme: Wrap sidebar components in div to allow customizing their
layout via CSS</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9827">#9827</a>: i18n: Sort items in glossary by translated terms</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9899">#9899</a>: py domain: Allows to specify cross-reference specifier (<code class="docutils literal notranslate"><span class="pre">.</span></code> and
<code class="docutils literal notranslate"><span class="pre">~</span></code>) as <code class="docutils literal notranslate"><span class="pre">:type:</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9894">#9894</a>: linkcheck: add option <code class="docutils literal notranslate"><span class="pre">linkcheck_exclude_documents</span></code> to disable link
checking in matched documents.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9793">#9793</a>: sphinx-build: Allow to use the parallel build feature in macOS on macOS
and Python3.8+</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10055">#10055</a>: sphinx-build: Create directories when <code class="docutils literal notranslate"><span class="pre">-w</span></code> option given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9993">#9993</a>: std domain: Allow to refer an inline target (ex. <code class="docutils literal notranslate"><span class="pre">_`target</span> <span class="pre">name`</span></code>)
via <a class="reference internal" href="usage/restructuredtext/roles.html#role-ref" title="ref role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">ref</span></code></a> role</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9981">#9981</a>: std domain: Strip value part of the option directive from general index</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9391">#9391</a>: texinfo: improve variable in <code class="docutils literal notranslate"><span class="pre">samp</span></code> role</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9578">#9578</a>: texinfo: Add <a class="reference internal" href="usage/configuration.html#confval-texinfo_cross_references"><code class="xref std std-confval docutils literal notranslate"><span class="pre">texinfo_cross_references</span></code></a> to disable cross
references for readability with standalone readers</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9822">#9822</a> (and <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9062">#9062</a>), add new Intersphinx role <a class="reference internal" href="usage/extensions/intersphinx.html#role-external" title="external role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">external</span></code></a> for explict
lookup in the external projects, without resolving to the local project.</p></li>
</ul>
</section>
<section id="id365">
<h3>Bugs fixed<a class="headerlink" href="#id365" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9866">#9866</a>: autodoc: doccomment for the imported class was ignored</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9883">#9883</a>: autodoc: doccomment for the alias to mocked object was ignored</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9908">#9908</a>: autodoc: debug message is shown on building document using NewTypes
with Python 3.10</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9968">#9968</a>: autodoc: instance variables are not shown if __init__ method has
position-only-arguments</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9194">#9194</a>: autodoc: types under the “typing” module are not hyperlinked</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10009">#10009</a>: autodoc: Crashes if target object raises an error on getting docstring</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10058">#10058</a>: autosummary: Imported members are not shown when
<code class="docutils literal notranslate"><span class="pre">autodoc_class_signature</span> <span class="pre">=</span> <span class="pre">'separated'</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9947">#9947</a>: i18n: topic directive having a bullet list can’t be translatable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9878">#9878</a>: mathjax: MathJax configuration is placed after loading MathJax itself</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9932">#9932</a>: napoleon: empty “returns” section is generated even if no description</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9857">#9857</a>: Generated RFC links use outdated base url</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9909">#9909</a>: HTML, prevent line-wrapping in literal text.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10061">#10061</a>: html theme: Configuration values added by themes are not be able to
override from conf.py</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10073">#10073</a>: imgconverter: Unnecessary availablity check is called for “data” URIs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9925">#9925</a>: LaTeX: prohibit also with <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code> line splitting at dashes of
inline and parsed literals</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9944">#9944</a>: LaTeX: extra vertical whitespace for some nested declarations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9940">#9940</a>: LaTeX: Multi-function declaration in Python domain has cramped
vertical spacing in latexpdf output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10015">#10015</a>: py domain: types under the “typing” module are not hyperlinked defined
at info-field-list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9390">#9390</a>: texinfo: Do not emit labels inside footnotes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9413">#9413</a>: xml: Invalid XML was generated when cross referencing python objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9979">#9979</a>: Error level messages were displayed as warning messages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10057">#10057</a>: Failed to scan documents if the project is placed onto the root
directory</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9636">#9636</a>: code-block: <code class="docutils literal notranslate"><span class="pre">:dedent:</span></code> without argument did strip newlines</p></li>
</ul>
</section>
</section>
<section id="release-4-3-2-released-dec-19-2021">
<h2>Release 4.3.2 (released Dec 19, 2021)<a class="headerlink" href="#release-4-3-2-released-dec-19-2021" title="Link to this heading">¶</a></h2>
<section id="id389">
<h3>Bugs fixed<a class="headerlink" href="#id389" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9917">#9917</a>: C and C++, parse fundamental types no matter the order of simple type
specifiers.</p></li>
</ul>
</section>
</section>
<section id="release-4-3-1-released-nov-28-2021">
<h2>Release 4.3.1 (released Nov 28, 2021)<a class="headerlink" href="#release-4-3-1-released-nov-28-2021" title="Link to this heading">¶</a></h2>
<section id="id391">
<h3>Features added<a class="headerlink" href="#id391" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9864">#9864</a>: mathjax: Support chnaging the loading method of MathJax to “defer” via
<a class="reference internal" href="usage/extensions/math.html#confval-mathjax_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mathjax_options</span></code></a></p></li>
</ul>
</section>
<section id="id393">
<h3>Bugs fixed<a class="headerlink" href="#id393" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9838">#9838</a>: autodoc: AttributeError is raised on building document for functions
decorated by functools.lru_cache</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9879">#9879</a>: autodoc: AttributeError is raised on building document for an object
having invalid __doc__ attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9844">#9844</a>: autodoc: Failed to process a function wrapped with functools.partial if
<a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_preserve_defaults"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_preserve_defaults</span></code></a> enabled</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9872">#9872</a>: html: Class namespace collision between autodoc signatures and
docutils-0.17</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9868">#9868</a>: imgmath: Crashed if the dvisvgm command failed to convert equation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9864">#9864</a>: mathjax: Failed to render equations via MathJax v2. The loading method
of MathJax is back to “async” method again</p></li>
</ul>
</section>
</section>
<section id="release-4-3-0-released-nov-11-2021">
<h2>Release 4.3.0 (released Nov 11, 2021)<a class="headerlink" href="#release-4-3-0-released-nov-11-2021" title="Link to this heading">¶</a></h2>
<section id="id400">
<h3>Dependencies<a class="headerlink" href="#id400" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Support Python 3.10</p></li>
</ul>
</section>
<section id="id401">
<h3>Incompatible changes<a class="headerlink" href="#id401" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9649">#9649</a>: <code class="docutils literal notranslate"><span class="pre">searchindex.js</span></code>: the embedded data has changed format to allow
objects with the same name in different domains.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9672">#9672</a>: The rendering of Python domain declarations is implemented
with more docutils nodes to allow better CSS styling.
It may break existing styling.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9672">#9672</a>: the signature of
<code class="docutils literal notranslate"><span class="pre">domains.python.PyObject.get_signature_prefix</span></code> has changed to
return a list of nodes instead of a plain string.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9695">#9695</a>: <code class="docutils literal notranslate"><span class="pre">domains.js.JSObject.display_prefix</span></code> has been changed into a method
<code class="docutils literal notranslate"><span class="pre">get_display_prefix</span></code> which now returns a list of nodes
instead of a plain string.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9695">#9695</a>: The rendering of Javascript domain declarations is implemented
with more docutils nodes to allow better CSS styling.
It may break existing styling.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9450">#9450</a>: mathjax: Load MathJax via “defer” strategy</p></li>
</ul>
</section>
<section id="id408">
<h3>Deprecated<a class="headerlink" href="#id408" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.AttributeDocumenter._datadescriptor</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html.HTMLTranslator._fieldlist_row_index</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html.HTMLTranslator._table_row_index</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html5.HTML5Translator._fieldlist_row_index</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html5.HTML5Translator._table_row_index</span></code></p></li>
</ul>
</section>
<section id="id409">
<h3>Features added<a class="headerlink" href="#id409" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9639">#9639</a>: autodoc: Support asynchronous generator functions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9664">#9664</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">autodoc-process-bases</span></code> supports to inject reST snippet as a
base class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9691">#9691</a>: C, added new info-field <code class="docutils literal notranslate"><span class="pre">retval</span></code>
for <a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-function" title="c:function directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:function</span></code></a> and <a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-macro" title="c:macro directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:macro</span></code></a>.</p></li>
<li><p>C++, added new info-field <code class="docutils literal notranslate"><span class="pre">retval</span></code> for <a class="reference internal" href="usage/restructuredtext/domains.html#directive-cpp-function" title="cpp:function directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">cpp:function</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9618">#9618</a>: i18n: Add <a class="reference internal" href="usage/configuration.html#confval-gettext_allow_fuzzy_translations"><code class="xref std std-confval docutils literal notranslate"><span class="pre">gettext_allow_fuzzy_translations</span></code></a> to allow “fuzzy”
messages for translation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9672">#9672</a>: More CSS classes on Python domain descriptions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9695">#9695</a>: More CSS classes on Javascript domain descriptions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9683">#9683</a>: Revert the removal of <code class="docutils literal notranslate"><span class="pre">add_stylesheet()</span></code> API. It will be kept until
the Sphinx 6.0 release</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2068">#2068</a>, add <a class="reference internal" href="usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">intersphinx_disabled_reftypes</span></code></a> for disabling
interphinx resolution of cross-references that do not have an explicit
inventory specification. Specific types of cross-references can be disabled,
e.g., <code class="docutils literal notranslate"><span class="pre">std:doc</span></code> or all cross-references in a specific domain,
e.g., <code class="docutils literal notranslate"><span class="pre">std:*</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9623">#9623</a>: Allow to suppress “toctree contains reference to excluded document”
warnings using <a class="reference internal" href="usage/configuration.html#confval-suppress_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">suppress_warnings</span></code></a></p></li>
</ul>
</section>
<section id="id419">
<h3>Bugs fixed<a class="headerlink" href="#id419" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9630">#9630</a>: autodoc: Failed to build cross references if <a class="reference internal" href="usage/configuration.html#confval-primary_domain"><code class="xref std std-confval docutils literal notranslate"><span class="pre">primary_domain</span></code></a>
is not ‘py’</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9644">#9644</a>: autodoc: Crashed on getting source info from problematic object</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9655">#9655</a>: autodoc: mocked object having doc comment is warned unexpectedly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9651">#9651</a>: autodoc: return type field is not generated even if
<a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints_description_target"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints_description_target</span></code></a> is set to “documented” when
its info-field-list contains <code class="docutils literal notranslate"><span class="pre">:returns:</span></code> field</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9657">#9657</a>: autodoc: The base class for a subclass of mocked object is incorrect</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9607">#9607</a>: autodoc: Incorrect base class detection for the subclasses of the
generic class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9755">#9755</a>: autodoc: memory addresses are shown for aliases</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9752">#9752</a>: autodoc: Failed to detect type annotation for slots attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9756">#9756</a>: autodoc: Crashed if classmethod does not have __func__ attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9757">#9757</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_inherit_docstrings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_inherit_docstrings</span></code></a> does not effect to
overridden classmethods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9781">#9781</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_preserve_defaults"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_preserve_defaults</span></code></a> does not support
hexadecimal numeric</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9630">#9630</a>: autosummary: Failed to build summary table if <a class="reference internal" href="usage/configuration.html#confval-primary_domain"><code class="xref std std-confval docutils literal notranslate"><span class="pre">primary_domain</span></code></a>
is not ‘py’</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9670">#9670</a>: html: Fix download file with special characters</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9710">#9710</a>: html: Wrong styles for even/odd rows in nested tables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9763">#9763</a>: html: parameter name and its type annotation are not separated in HTML</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9649">#9649</a>: HTML search: when objects have the same name but in different domains,
return all of them as result instead of just one.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7634">#7634</a>: intersphinx: references on the file in sub directory are broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9737">#9737</a>: LaTeX: hlist is rendered as a list containing “aggedright” text</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9678">#9678</a>: linkcheck: file extension was shown twice in warnings</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9697">#9697</a>: py domain: An index entry with parens was registered for <code class="docutils literal notranslate"><span class="pre">py:method</span></code>
directive with <code class="docutils literal notranslate"><span class="pre">:property:</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9775">#9775</a>: py domain: Literal typehint was converted to a cross reference when
<a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints</span></code></a><code class="docutils literal notranslate"><span class="pre">='description'</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9708">#9708</a>: needs_extension failed to check double-digit version correctly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9688">#9688</a>: Fix Sphinx patched <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#code">code</a> does not recognize <code class="docutils literal notranslate"><span class="pre">:class:</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9733">#9733</a>: Fix for logging handler flushing warnings in the middle of the docs
build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9656">#9656</a>: Fix warnings without subtype being incorrectly suppressed</p></li>
<li><p>Intersphinx, for unresolved references with an explicit inventory,
e.g., <code class="docutils literal notranslate"><span class="pre">proj:myFunc</span></code>, leave the inventory prefix in the unresolved text.</p></li>
</ul>
</section>
</section>
<section id="release-4-2-0-released-sep-12-2021">
<h2>Release 4.2.0 (released Sep 12, 2021)<a class="headerlink" href="#release-4-2-0-released-sep-12-2021" title="Link to this heading">¶</a></h2>
<section id="id445">
<h3>Features added<a class="headerlink" href="#id445" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9445">#9445</a>: autodoc: Support class properties</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9479">#9479</a>: autodoc: Emit a warning if target is a mocked object</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9560">#9560</a>: autodoc: Allow to refer NewType instances with module name in Python
3.10 or above</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9447">#9447</a>: html theme: Expose the version of Sphinx in the form of tuple as a
template variable <code class="docutils literal notranslate"><span class="pre">sphinx_version_tuple</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9594">#9594</a>: manpage: Suppress the title of man page if description is empty</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9445">#9445</a>: py domain: <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-property" title="py:property directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:property</span></code></a> directive supports <code class="docutils literal notranslate"><span class="pre">:classmethod:</span></code>
option to describe the class property</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9524">#9524</a>: test: SphinxTestApp can take <code class="docutils literal notranslate"><span class="pre">builddir</span></code> as an argument</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9535">#9535</a>: C and C++, support more fundamental types, including GNU extensions.</p></li>
</ul>
</section>
<section id="id454">
<h3>Bugs fixed<a class="headerlink" href="#id454" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9608">#9608</a>: apidoc: apidoc does not generate a module definition for implicit
namespace package</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9504">#9504</a>: autodoc: generate incorrect reference to the parent class if the target
class inherites the class having <code class="docutils literal notranslate"><span class="pre">_name</span></code> attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9537">#9537</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9589">#9589</a>: autodoc: Some objects under <code class="docutils literal notranslate"><span class="pre">typing</span></code> module are not displayed
well with the HEAD of 3.10</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9487">#9487</a>: autodoc: typehint for cached_property is not shown</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9509">#9509</a>: autodoc: AttributeError is raised on failed resolving typehints</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9518">#9518</a>: autodoc: autodoc_docstring_signature does not effect to <code class="docutils literal notranslate"><span class="pre">__init__()</span></code>
and <code class="docutils literal notranslate"><span class="pre">__new__()</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9522">#9522</a>: autodoc: PEP 585 style typehints having arguments (ex. <code class="docutils literal notranslate"><span class="pre">list[int]</span></code>)
are not displayed well</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9481">#9481</a>: autosummary: some warnings contain non-existing filenames</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9568">#9568</a>: autosummary: summarise overlined sectioned headings correctly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9600">#9600</a>: autosummary: Type annotations which contain commas in autosummary table
are not removed completely</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9481">#9481</a>: c domain: some warnings contain non-existing filenames</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9481">#9481</a>: cpp domain: some warnings contain non-existing filenames</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9456">#9456</a>: html search: abbreation marks are inserted to the search result if
failed to fetch the content of the page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9617">#9617</a>: html search: The JS requirement warning is shown if browser is slow</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9267">#9267</a>: html theme: CSS and JS files added by theme were loaded twice</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9585">#9585</a>: py domain: <code class="docutils literal notranslate"><span class="pre">:type:</span></code> option for <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-property" title="py:property directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:property</span></code></a> directive does
not create a hyperlink</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9576">#9576</a>: py domain: Literal typehint was converted to a cross reference</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9535">#9535</a> comment: C++, fix parsing of defaulted function parameters that are
function pointers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9564">#9564</a>: smartquotes: don’t adjust typography for text with
language-highlighted <code class="docutils literal notranslate"><span class="pre">:code:</span></code> role.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9512">#9512</a>: sphinx-build: crashed with the HEAD of Python 3.10</p></li>
</ul>
</section>
</section>
<section id="release-4-1-2-released-jul-27-2021">
<h2>Release 4.1.2 (released Jul 27, 2021)<a class="headerlink" href="#release-4-1-2-released-jul-27-2021" title="Link to this heading">¶</a></h2>
<section id="id476">
<h3>Incompatible changes<a class="headerlink" href="#id476" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9435">#9435</a>: linkcheck: Disable checking automatically generated anchors on
github.com (ex. anchors in reST/Markdown documents)</p></li>
</ul>
</section>
<section id="id478">
<h3>Bugs fixed<a class="headerlink" href="#id478" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9489">#9489</a>: autodoc: Custom types using <code class="docutils literal notranslate"><span class="pre">typing.NewType</span></code> are not displayed well
with the HEAD of 3.10</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9490">#9490</a>: autodoc: Some objects under <code class="docutils literal notranslate"><span class="pre">typing</span></code> module are not displayed well
with the HEAD of 3.10</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9436">#9436</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9471">#9471</a>: autodoc: crashed if <code class="docutils literal notranslate"><span class="pre">autodoc_class_signature</span> <span class="pre">=</span> <span class="pre">"separated"</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9456">#9456</a>: html search: html_copy_source can’t control the search summaries</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9500">#9500</a>: LaTeX: Failed to build Japanese document on Windows</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9435">#9435</a>: linkcheck: Failed to check anchors in github.com</p></li>
</ul>
</section>
</section>
<section id="release-4-1-1-released-jul-15-2021">
<h2>Release 4.1.1 (released Jul 15, 2021)<a class="headerlink" href="#release-4-1-1-released-jul-15-2021" title="Link to this heading">¶</a></h2>
<section id="id486">
<h3>Dependencies<a class="headerlink" href="#id486" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9434">#9434</a>: sphinxcontrib-htmlhelp-2.0.0 or above</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9434">#9434</a>: sphinxcontrib-serializinghtml-1.1.5 or above</p></li>
</ul>
</section>
<section id="id489">
<h3>Bugs fixed<a class="headerlink" href="#id489" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9438">#9438</a>: html: HTML logo or Favicon specified as file not being found on output</p></li>
</ul>
</section>
</section>
<section id="release-4-1-0-released-jul-12-2021">
<h2>Release 4.1.0 (released Jul 12, 2021)<a class="headerlink" href="#release-4-1-0-released-jul-12-2021" title="Link to this heading">¶</a></h2>
<section id="id491">
<h3>Dependencies<a class="headerlink" href="#id491" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Support jinja2-3.0</p></li>
</ul>
</section>
<section id="id492">
<h3>Deprecated<a class="headerlink" href="#id492" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>The <code class="docutils literal notranslate"><span class="pre">app</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.environment.BuildEnvironment</span></code> becomes
required</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.application.Sphinx.html_theme</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary._app</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.docstrings.extract_metadata()</span></code></p></li>
</ul>
</section>
<section id="id493">
<h3>Features added<a class="headerlink" href="#id493" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8107">#8107</a>: autodoc: Add <code class="docutils literal notranslate"><span class="pre">class-doc-from</span></code> option to <a class="reference internal" href="usage/extensions/autodoc.html#directive-autoclass" title="autoclass directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">autoclass</span></code></a>
directive to control the content of the specific class like
<a class="reference internal" href="usage/extensions/autodoc.html#confval-autoclass_content"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoclass_content</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8588">#8588</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_type_aliases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_type_aliases</span></code></a> now supports dotted name. It
allows you to define an alias for a class with module name like
<code class="docutils literal notranslate"><span class="pre">foo.bar.BazClass</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9175">#9175</a>: autodoc: Special member is not documented in the module</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9195">#9195</a>: autodoc: The arguments of <code class="docutils literal notranslate"><span class="pre">typing.Literal</span></code> are wrongly rendered</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9185">#9185</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints</span></code></a> allows <code class="docutils literal notranslate"><span class="pre">'both'</span></code> setting to
allow typehints to be included both in the signature and description</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4257">#4257</a>: autodoc: Add <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_class_signature"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_class_signature</span></code></a> to separate the class
entry and the definition of <code class="docutils literal notranslate"><span class="pre">__init__()</span></code> method</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8061">#8061</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9218">#9218</a>: autodoc: Support variable comment for alias classes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3014">#3014</a>: autodoc: Add <a class="reference internal" href="usage/extensions/autodoc.html#event-autodoc-process-bases"><code class="xref std std-event docutils literal notranslate"><span class="pre">autodoc-process-bases</span></code></a> to modify the base classes
of the class definitions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9272">#9272</a>: autodoc: Render enum values for the default argument value better</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9384">#9384</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">autodoc_typehints='none'</span></code> now erases typehints for
variables, attributes and properties</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3257">#3257</a>: autosummary: Support instance attributes for classes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9358">#9358</a>: html: Add “heading” role to the toctree items</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9225">#9225</a>: html: Add span tag to the return typehint of method/function</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9129">#9129</a>: html search: Show search summaries when html_copy_source = False</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9307">#9307</a>: html search: Prevent corrections and completions in search field</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9120">#9120</a>: html theme: Eliminate prompt characters of code-block from copyable
text</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9176">#9176</a>: i18n: Emit a debug message if message catalog file not found under
<a class="reference internal" href="usage/configuration.html#confval-locale_dirs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">locale_dirs</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9414">#9414</a>: LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9016">#9016</a>: linkcheck: Support checking anchors on github.com</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9016">#9016</a>: linkcheck: Add a new event <a class="reference internal" href="extdev/appapi.html#event-linkcheck-process-uri"><code class="xref std std-event docutils literal notranslate"><span class="pre">linkcheck-process-uri</span></code></a> to modify
URIs before checking hyperlinks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6525">#6525</a>: linkcheck: Add <a class="reference internal" href="usage/configuration.html#confval-linkcheck_allowed_redirects"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_allowed_redirects</span></code></a> to mark
hyperlinks that are redirected to expected URLs as “working”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1874">#1874</a>: py domain: Support union types using <code class="docutils literal notranslate"><span class="pre">|</span></code> in info-field-list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9268">#9268</a>: py domain: <a class="reference internal" href="usage/configuration.html#confval-python_use_unqualified_type_names"><code class="xref std std-confval docutils literal notranslate"><span class="pre">python_use_unqualified_type_names</span></code></a> supports type
field in info-field-list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9097">#9097</a>: Optimize the parallel build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9131">#9131</a>: Add <a class="reference internal" href="usage/configuration.html#confval-nitpick_ignore_regex"><code class="xref std std-confval docutils literal notranslate"><span class="pre">nitpick_ignore_regex</span></code></a> to ignore nitpicky warnings using
regular expressions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9174">#9174</a>: Add <code class="docutils literal notranslate"><span class="pre">Sphinx.set_html_assets_policy</span></code> to tell extensions to include
HTML assets in all the pages. Extensions can check this via
<code class="docutils literal notranslate"><span class="pre">Sphinx.registry.html_assets_policy</span></code></p></li>
<li><p>C++, add support for</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">inline</span></code> variables,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">consteval</span></code> functions,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">constinit</span></code> variables,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">char8_t</span></code>,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">explicit(<constant</span> <span class="pre">expression>)</span></code> specifier,</p></li>
<li><p>digit separators in literals, and</p></li>
<li><p>constraints in placeholder type specifiers, aka. adjective syntax
(e.g., <code class="docutils literal notranslate"><span class="pre">Sortable</span> <span class="pre">auto</span> <span class="pre">&v</span></code>).</p></li>
</ul>
</li>
<li><p>C, add support for digit separators in literals.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9166">#9166</a>: LaTeX: support containers in LaTeX output</p></li>
</ul>
</section>
<section id="id522">
<h3>Bugs fixed<a class="headerlink" href="#id522" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8872">#8872</a>: autodoc: stacked singledispatches are wrongly rendered</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8597">#8597</a>: autodoc: a docsting having metadata only should be treated as
undocumented</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9185">#9185</a>: autodoc: typehints for overloaded functions and methods are inaccurate</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9250">#9250</a>: autodoc: The inherited method not having docstring is wrongly parsed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9283">#9283</a>: autodoc: autoattribute directive failed to generate document for an
attribute not having any comment</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9364">#9364</a>: autodoc: single element tuple on the default argument value is wrongly
rendered</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9362">#9362</a>: autodoc: AttributeError is raised on processing a subclass of Tuple[()]</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9404">#9404</a>: autodoc: TypeError is raised on processing dict-like object (not a
class) via autoclass directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9317">#9317</a>: html: Pushing left key causes visiting the next page at the first page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9381">#9381</a>: html: URL for html_favicon and html_log does not work</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9270">#9270</a>: html theme : pyramid theme generates incorrect logo links</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9217">#9217</a>: manpage: The name of manpage directory that is generated by
<a class="reference internal" href="usage/configuration.html#confval-man_make_section_directory"><code class="xref std std-confval docutils literal notranslate"><span class="pre">man_make_section_directory</span></code></a> is not correct</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9350">#9350</a>: manpage: Fix font isn’t reset after keyword at the top of samp role</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9306">#9306</a>: Linkcheck reports broken link when remote server closes the connection
on HEAD request</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9280">#9280</a>: py domain: “exceptions” module is not displayed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9418">#9418</a>: py domain: a Callable annotation with no parameters
(e.g. <code class="docutils literal notranslate"><span class="pre">Callable[[],</span> <span class="pre">None])</span></code> will be rendered with a bracket missing
(<code class="docutils literal notranslate"><span class="pre">Callable[],</span> <span class="pre">None]</span></code>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9319">#9319</a>: quickstart: Make sphinx-quickstart exit when conf.py already exists</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9387">#9387</a>: xml: XML Builder ignores custom visitors</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9224">#9224</a>: <code class="docutils literal notranslate"><span class="pre">:param:</span></code> and <code class="docutils literal notranslate"><span class="pre">:type:</span></code> fields does not support a type containing
whitespace (ex. <code class="docutils literal notranslate"><span class="pre">Dict[str,</span> <span class="pre">str]</span></code>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8945">#8945</a>: when transforming typed fields, call the specified role instead of
making an single xref. For C and C++, use the <code class="docutils literal notranslate"><span class="pre">expr</span></code> role for typed fields.</p></li>
</ul>
</section>
</section>
<section id="release-4-0-3-released-jul-05-2021">
<h2>Release 4.0.3 (released Jul 05, 2021)<a class="headerlink" href="#release-4-0-3-released-jul-05-2021" title="Link to this heading">¶</a></h2>
<section id="id543">
<h3>Features added<a class="headerlink" href="#id543" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>C, add C23 keywords <code class="docutils literal notranslate"><span class="pre">_Decimal32</span></code>, <code class="docutils literal notranslate"><span class="pre">_Decimal64</span></code>, and <code class="docutils literal notranslate"><span class="pre">_Decimal128</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9354">#9354</a>: C, add <a class="reference internal" href="usage/configuration.html#confval-c_extra_keywords"><code class="xref std std-confval docutils literal notranslate"><span class="pre">c_extra_keywords</span></code></a> to allow user-defined keywords
during parsing.</p></li>
<li><p>Revert the removal of <code class="docutils literal notranslate"><span class="pre">sphinx.util:force_decode()</span></code> to become some 3rd party
extensions available again during 5.0</p></li>
</ul>
</section>
<section id="id545">
<h3>Bugs fixed<a class="headerlink" href="#id545" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9330">#9330</a>: changeset domain: <a class="reference internal" href="usage/restructuredtext/directives.html#directive-versionchanged" title="versionchanged directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">versionchanged</span></code></a> with contents being a list
will cause error during pdf build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9313">#9313</a>: LaTeX: complex table with merged cells broken since 4.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9305">#9305</a>: LaTeX: backslash may cause Improper discretionary list pdf build error
with Japanese engines</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9354">#9354</a>: C, remove special macro names from the keyword list.
See also <a class="reference internal" href="usage/configuration.html#confval-c_extra_keywords"><code class="xref std std-confval docutils literal notranslate"><span class="pre">c_extra_keywords</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9322">#9322</a>: KeyError is raised on PropagateDescDomain transform</p></li>
</ul>
</section>
</section>
<section id="release-4-0-2-released-may-20-2021">
<h2>Release 4.0.2 (released May 20, 2021)<a class="headerlink" href="#release-4-0-2-released-may-20-2021" title="Link to this heading">¶</a></h2>
<section id="id551">
<h3>Dependencies<a class="headerlink" href="#id551" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9216">#9216</a>: Support jinja2-3.0</p></li>
</ul>
</section>
<section id="id553">
<h3>Incompatible changes<a class="headerlink" href="#id553" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9222">#9222</a>: Update Underscore.js to 1.13.1</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9217">#9217</a>: manpage: Stop creating a section directory on build manpage by default
(see <a class="reference internal" href="usage/configuration.html#confval-man_make_section_directory"><code class="xref std std-confval docutils literal notranslate"><span class="pre">man_make_section_directory</span></code></a>)</p></li>
</ul>
</section>
<section id="id556">
<h3>Bugs fixed<a class="headerlink" href="#id556" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9210">#9210</a>: viewcode: crashed if non importable modules found on parallel build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9240">#9240</a>: Unknown node error for pending_xref_condition is raised if an extension
that does not support the node installs a missing-reference handler</p></li>
</ul>
</section>
</section>
<section id="release-4-0-1-released-may-11-2021">
<h2>Release 4.0.1 (released May 11, 2021)<a class="headerlink" href="#release-4-0-1-released-may-11-2021" title="Link to this heading">¶</a></h2>
<section id="id559">
<h3>Bugs fixed<a class="headerlink" href="#id559" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9189">#9189</a>: autodoc: crashed when ValueError is raised on generating signature
from a property of the class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9188">#9188</a>: autosummary: warning is emitted if list value is set to
autosummary_generate</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8380">#8380</a>: html search: tags for search result are broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9198">#9198</a>: i18n: Babel emits errors when running compile_catalog</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9205">#9205</a>: py domain: The :canonical: option causes “more than one target for
cross-reference” warning</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9201">#9201</a>: websupport: UndefinedError is raised: ‘css_tag’ is undefined</p></li>
</ul>
</section>
</section>
<section id="release-4-0-0-released-may-09-2021">
<h2>Release 4.0.0 (released May 09, 2021)<a class="headerlink" href="#release-4-0-0-released-may-09-2021" title="Link to this heading">¶</a></h2>
<section id="id566">
<h3>Dependencies<a class="headerlink" href="#id566" title="Link to this heading">¶</a></h3>
<p>4.0.0b1</p>
<ul class="simple">
<li><p>Drop python 3.5 support</p></li>
<li><p>Drop docutils 0.12 and 0.13 support</p></li>
<li><p>LaTeX: add <code class="docutils literal notranslate"><span class="pre">tex-gyre</span></code> font dependency</p></li>
</ul>
<p>4.0.0b2</p>
<ul class="simple">
<li><p>Support docutils-0.17. Please notice it changes the output of HTML builder.
Some themes do not support it, and you need to update your custom CSS to
upgrade it.</p></li>
</ul>
</section>
<section id="id567">
<h3>Incompatible changes<a class="headerlink" href="#id567" title="Link to this heading">¶</a></h3>
<p>4.0.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8539">#8539</a>: autodoc: info-field-list is generated into the class description when
<a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints</span></code></a><code class="docutils literal notranslate"><span class="pre">='description'</span></code> and
<a class="reference internal" href="usage/extensions/autodoc.html#confval-autoclass_content"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoclass_content</span></code></a><code class="docutils literal notranslate"><span class="pre">='class'</span></code> set</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8898">#8898</a>: extlinks: “%s” becomes required keyword in the link caption string</p></li>
<li><p>domain: The <code class="docutils literal notranslate"><span class="pre">Index</span></code> class becomes subclasses of <code class="docutils literal notranslate"><span class="pre">abc.ABC</span></code> to indicate
methods that must be overridden in the concrete classes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4826">#4826</a>: py domain: The structure of python objects is changed. A boolean value
is added to indicate that the python object is canonical one</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7425">#7425</a>: MathJax: The MathJax was changed from 2 to 3. Users using a custom
MathJax configuration may have to set the old MathJax path or update their
configuration for version 3. See <a class="reference internal" href="usage/extensions/math.html#module-sphinx.ext.mathjax" title="sphinx.ext.mathjax: Render math using JavaScript via MathJax."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.mathjax</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7784">#7784</a>: i18n: The msgid for alt text of image is changed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5560">#5560</a>: napoleon: <a class="reference internal" href="usage/extensions/napoleon.html#confval-napoleon_use_param"><code class="xref std std-confval docutils literal notranslate"><span class="pre">napoleon_use_param</span></code></a> also affect “other parameters”
section</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7996">#7996</a>: manpage: Make a section directory on build manpage by default (see
<a class="reference internal" href="usage/configuration.html#confval-man_make_section_directory"><code class="xref std std-confval docutils literal notranslate"><span class="pre">man_make_section_directory</span></code></a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7849">#7849</a>: html: Change the default setting of
<a class="reference internal" href="usage/configuration.html#confval-html_codeblock_linenos_style"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_codeblock_linenos_style</span></code></a> to <code class="docutils literal notranslate"><span class="pre">'inline'</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8380">#8380</a>: html search: search results are wrapped with <code class="docutils literal notranslate"><span class="pre"><p></span></code> instead of
<code class="docutils literal notranslate"><span class="pre"><div></span></code></p></li>
<li><p>html theme: Move a script tag for documentation_options.js in
basic/layout.html to <code class="docutils literal notranslate"><span class="pre">script_files</span></code> variable</p></li>
<li><p>html theme: Move CSS tags in basic/layout.html to <code class="docutils literal notranslate"><span class="pre">css_files</span></code> variable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8915">#8915</a>: html theme: Emit a warning for sphinx_rtd_theme-0.2.4 or older</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8508">#8508</a>: LaTeX: uplatex becomes a default setting of latex_engine for Japanese
documents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5977">#5977</a>: py domain: <code class="docutils literal notranslate"><span class="pre">:var:</span></code>, <code class="docutils literal notranslate"><span class="pre">:cvar:</span></code> and <code class="docutils literal notranslate"><span class="pre">:ivar:</span></code> fields do not create
cross-references</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4550">#4550</a>: The <code class="docutils literal notranslate"><span class="pre">align</span></code> attribute of <code class="docutils literal notranslate"><span class="pre">figure</span></code> and <code class="docutils literal notranslate"><span class="pre">table</span></code> nodes becomes
<code class="docutils literal notranslate"><span class="pre">None</span></code> by default instead of <code class="docutils literal notranslate"><span class="pre">'default'</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8769">#8769</a>: LaTeX refactoring: split sphinx.sty into multiple files and rename
some auxiliary files created in <code class="docutils literal notranslate"><span class="pre">latex</span></code> build output repertory</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8937">#8937</a>: Use explicit title instead of <no title></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8487">#8487</a>: The :file: option for csv-table directive now recognizes an absolute
path as a relative path from source directory</p></li>
</ul>
<p>4.0.0b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9023">#9023</a>: Change the CSS classes on <a class="reference internal" href="usage/restructuredtext/domains.html#role-cpp-expr" title="cpp:expr role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">cpp:expr</span></code></a> and
<a class="reference internal" href="usage/restructuredtext/domains.html#role-cpp-texpr" title="cpp:texpr role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">cpp:texpr</span></code></a>.</p></li>
</ul>
</section>
<section id="id585">
<h3>Deprecated<a class="headerlink" href="#id585" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="usage/configuration.html#confval-html_codeblock_linenos_style"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_codeblock_linenos_style</span></code></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">favicon</span></code> and <code class="docutils literal notranslate"><span class="pre">logo</span></code> variable in HTML templates</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.patches.CSVTable</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.patches.ListTable</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.patches.RSTTable</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.directive.DocumenterBridge.filename_set</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.directive.DocumenterBridge.warn()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.registry.SphinxComponentRegistry.get_source_input()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.registry.SphinxComponentRegistry.source_inputs</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.transforms.FigureAligner</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.convert_with_2to3()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.execfile_()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.smartypants</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.typing.DirectiveOption</span></code></p></li>
</ul>
</section>
<section id="id586">
<h3>Features added<a class="headerlink" href="#id586" title="Link to this heading">¶</a></h3>
<p>4.0.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8924">#8924</a>: autodoc: Support <code class="docutils literal notranslate"><span class="pre">bound</span></code> argument for TypeVar</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7383">#7383</a>: autodoc: Support typehints for properties</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5603">#5603</a>: autodoc: Allow to refer to a python class using its canonical name
when the class has two different names; a canonical name and an alias name</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8539">#8539</a>: autodoc: Add <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints_description_target"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints_description_target</span></code></a> to control
the behavior of <code class="docutils literal notranslate"><span class="pre">autodoc_typehints=description</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8841">#8841</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_docstring_signature"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_docstring_signature</span></code></a> will continue to look
for multiple signature lines without backslash character</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7549">#7549</a>: autosummary: Enable <a class="reference internal" href="usage/extensions/autosummary.html#confval-autosummary_generate"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosummary_generate</span></code></a> by default</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8898">#8898</a>: extlinks: Allow %s in link caption string</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4826">#4826</a>: py domain: Add <code class="docutils literal notranslate"><span class="pre">:canonical:</span></code> option to python directives to describe
the location where the object is defined</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7199">#7199</a>: py domain: Add <a class="reference internal" href="usage/configuration.html#confval-python_use_unqualified_type_names"><code class="xref std std-confval docutils literal notranslate"><span class="pre">python_use_unqualified_type_names</span></code></a> to suppress
the module name of the python reference if it can be resolved (experimental)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7068">#7068</a>: py domain: Add <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-property" title="py:property directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:property</span></code></a> directive to describe a property</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7784">#7784</a>: i18n: The alt text for image is translated by default (without
<a class="reference internal" href="usage/configuration.html#confval-gettext_additional_targets"><code class="xref std std-confval docutils literal notranslate"><span class="pre">gettext_additional_targets</span></code></a> setting)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2018">#2018</a>: html: <a class="reference internal" href="usage/configuration.html#confval-html_favicon"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_favicon</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-html_logo"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_logo</span></code></a> now accept URL
for the image</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8070">#8070</a>: html search: Support searching for 2characters word</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9036">#9036</a>: html theme: Allow to inherite the search page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8938">#8938</a>: imgconverter: Show the error of the command availability check</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7830">#7830</a>: Add debug logs for change detection of sources and templates</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8201">#8201</a>: Emit a warning if toctree contains duplicated entries</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8326">#8326</a>: <code class="docutils literal notranslate"><span class="pre">master_doc</span></code> is now renamed to <a class="reference internal" href="usage/configuration.html#confval-root_doc"><code class="xref std std-confval docutils literal notranslate"><span class="pre">root_doc</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8942">#8942</a>: C++, add support for the C++20 spaceship operator, <code class="docutils literal notranslate"><span class="pre"><=></span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7199">#7199</a>: A new node, <code class="docutils literal notranslate"><span class="pre">sphinx.addnodes.pending_xref_condition</span></code> has been added.
It can be used to choose appropriate content of the reference by conditions.</p></li>
</ul>
<p>4.0.0b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8818">#8818</a>: autodoc: Super class having <code class="docutils literal notranslate"><span class="pre">Any</span></code> arguments causes nit-picky warning</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9095">#9095</a>: autodoc: TypeError is raised on processing broken metaclass</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9110">#9110</a>: autodoc: metadata of GenericAlias is not rendered as a reference in
py37+</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9098">#9098</a>: html: copy-range protection for doctests doesn’t work in Safari</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9103">#9103</a>: LaTeX: imgconverter: conversion runs even if not needed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8127">#8127</a>: py domain: Ellipsis in info-field-list causes nit-picky warning</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9121">#9121</a>: py domain: duplicated warning is emitted when both canonical and its
alias objects are defined on the document</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9023">#9023</a>: More CSS classes on domain descriptions, see <a class="reference internal" href="extdev/nodes.html#nodes"><span class="std std-ref">Doctree node classes added by Sphinx</span></a> for details.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8195">#8195</a>: mathjax: Rename <a class="reference internal" href="usage/extensions/math.html#confval-mathjax_config"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mathjax_config</span></code></a> to
<a class="reference internal" href="usage/extensions/math.html#confval-mathjax2_config"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mathjax2_config</span></code></a> and add <a class="reference internal" href="usage/extensions/math.html#confval-mathjax3_config"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mathjax3_config</span></code></a></p></li>
</ul>
</section>
<section id="id616">
<h3>Bugs fixed<a class="headerlink" href="#id616" title="Link to this heading">¶</a></h3>
<p>4.0.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8917">#8917</a>: autodoc: Raises a warning if function has wrong __globals__ value</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8415">#8415</a>: autodoc: a TypeVar imported from other module is not resolved (in
Python 3.7 or above)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8992">#8992</a>: autodoc: Failed to resolve types.TracebackType type annotation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8905">#8905</a>: html: html_add_permalinks=None and html_add_permalinks=”” are ignored</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8380">#8380</a>: html search: Paragraphs in search results are not identified as <code class="docutils literal notranslate"><span class="pre"><p></span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8915">#8915</a>: html theme: The translation of sphinx_rtd_theme does not work</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8342">#8342</a>: Emit a warning if a unknown domain is given for directive or role (ex.
<code class="docutils literal notranslate"><span class="pre">:unknown:doc:</span></code>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7241">#7241</a>: LaTeX: No wrapping for <code class="docutils literal notranslate"><span class="pre">cpp:enumerator</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8711">#8711</a>: LaTeX: backticks in code-blocks trigger latexpdf build warning (and font
change) with late TeXLive 2019</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8253">#8253</a>: LaTeX: Figures with no size defined get overscaled (compared to images
with size explicitly set in pixels) (fixed for <code class="docutils literal notranslate"><span class="pre">'pdflatex'/'lualatex'</span></code> only)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8881">#8881</a>: LaTeX: The depth of bookmarks panel in PDF is not enough for navigation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8874">#8874</a>: LaTeX: the fix to two minor Pygments LaTeXFormatter output issues ignore
Pygments style</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8925">#8925</a>: LaTeX: 3.5.0 <code class="docutils literal notranslate"><span class="pre">verbatimmaxunderfull</span></code> setting does not work as
expected</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8980">#8980</a>: LaTeX: missing line break in <code class="docutils literal notranslate"><span class="pre">\pysigline</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8995">#8995</a>: LaTeX: legacy <code class="docutils literal notranslate"><span class="pre">\pysiglinewithargsret</span></code> does not compute correctly
available horizontal space and should use a ragged right style</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9009">#9009</a>: LaTeX: “release” value with underscore leads to invalid LaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8911">#8911</a>: C++: remove the longest matching prefix in
<a class="reference internal" href="usage/configuration.html#confval-cpp_index_common_prefix"><code class="xref std std-confval docutils literal notranslate"><span class="pre">cpp_index_common_prefix</span></code></a> instead of the first that matches.</p></li>
<li><p>C, properly reject function declarations when a keyword is used
as parameter name.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8933">#8933</a>: viewcode: Failed to create back-links on parallel build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8960">#8960</a>: C and C++, fix rendering of (member) function pointer types in
function parameter lists.</p></li>
<li><p>C++, fix linking of names in array declarators, pointer to member
(function) declarators, and in the argument to <code class="docutils literal notranslate"><span class="pre">sizeof...</span></code>.</p></li>
<li><p>C, fix linking of names in array declarators.</p></li>
</ul>
<p>4.0.0b2</p>
<ul class="simple">
<li><p>C, C++, fix <code class="docutils literal notranslate"><span class="pre">KeyError</span></code> when an <code class="docutils literal notranslate"><span class="pre">alias</span></code> directive is the first C/C++
directive in a file with another C/C++ directive later.</p></li>
</ul>
<p>4.0.0b3</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9167">#9167</a>: html: Failed to add CSS files to the specific page</p></li>
</ul>
</section>
</section>
<section id="release-3-5-5-in-development">
<h2>Release 3.5.5 (in development)<a class="headerlink" href="#release-3-5-5-in-development" title="Link to this heading">¶</a></h2>
</section>
<section id="release-3-5-4-released-apr-11-2021">
<h2>Release 3.5.4 (released Apr 11, 2021)<a class="headerlink" href="#release-3-5-4-released-apr-11-2021" title="Link to this heading">¶</a></h2>
<section id="id637">
<h3>Dependencies<a class="headerlink" href="#id637" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9071">#9071</a>: Restrict docutils to 0.16</p></li>
</ul>
</section>
<section id="id639">
<h3>Bugs fixed<a class="headerlink" href="#id639" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9078">#9078</a>: autodoc: Async staticmethods and classmethods are considered as non
async coroutine-functions with Python3.10</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8870">#8870</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9001">#9001</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9051">#9051</a>: html theme: The style are not applied with docutils-0.17</p>
<ul>
<li><p>toctree captions</p></li>
<li><p>The content of <code class="docutils literal notranslate"><span class="pre">sidebar</span></code> directive</p></li>
<li><p>figures</p></li>
</ul>
</li>
</ul>
</section>
</section>
<section id="release-3-5-3-released-mar-20-2021">
<h2>Release 3.5.3 (released Mar 20, 2021)<a class="headerlink" href="#release-3-5-3-released-mar-20-2021" title="Link to this heading">¶</a></h2>
<section id="id644">
<h3>Features added<a class="headerlink" href="#id644" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8959">#8959</a>: using UNIX path separator in image directive confuses Sphinx on Windows</p></li>
</ul>
</section>
</section>
<section id="release-3-5-2-released-mar-06-2021">
<h2>Release 3.5.2 (released Mar 06, 2021)<a class="headerlink" href="#release-3-5-2-released-mar-06-2021" title="Link to this heading">¶</a></h2>
<section id="id646">
<h3>Bugs fixed<a class="headerlink" href="#id646" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8943">#8943</a>: i18n: Crashed by broken translation messages in ES, EL and HR</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8936">#8936</a>: LaTeX: A custom LaTeX builder fails with unknown node error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8952">#8952</a>: Exceptions raised in a Directive cause parallel builds to hang</p></li>
</ul>
</section>
</section>
<section id="release-3-5-1-released-feb-16-2021">
<h2>Release 3.5.1 (released Feb 16, 2021)<a class="headerlink" href="#release-3-5-1-released-feb-16-2021" title="Link to this heading">¶</a></h2>
<section id="id650">
<h3>Bugs fixed<a class="headerlink" href="#id650" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8883">#8883</a>: autodoc: AttributeError is raised on assigning __annotations__ on
read-only class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8884">#8884</a>: html: minified js stemmers not included in the distributed package</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8885">#8885</a>: html: AttributeError is raised if CSS/JS files are installed via
<a class="reference internal" href="usage/configuration.html#confval-html_context"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_context</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8880">#8880</a>: viewcode: ExtensionError is raised on incremental build after
unparsable python module found</p></li>
</ul>
</section>
</section>
<section id="release-3-5-0-released-feb-14-2021">
<h2>Release 3.5.0 (released Feb 14, 2021)<a class="headerlink" href="#release-3-5-0-released-feb-14-2021" title="Link to this heading">¶</a></h2>
<section id="id655">
<h3>Dependencies<a class="headerlink" href="#id655" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>LaTeX: <code class="docutils literal notranslate"><span class="pre">multicol</span></code> (it is anyhow a required part of the official latex2e
base distribution)</p></li>
</ul>
</section>
<section id="id656">
<h3>Incompatible changes<a class="headerlink" href="#id656" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Update Underscore.js to 1.12.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6550">#6550</a>: html: The config variable <code class="docutils literal notranslate"><span class="pre">html_add_permalinks</span></code> is replaced by
<a class="reference internal" href="usage/configuration.html#confval-html_permalinks"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_permalinks</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-html_permalinks_icon"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_permalinks_icon</span></code></a></p></li>
</ul>
</section>
<section id="id658">
<h3>Deprecated<a class="headerlink" href="#id658" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>pending_xref node for viewcode extension</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.CheckExternalLinksBuilder.good</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.linkcheck.node_line_or_0()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.directive.DocumenterBridge.reporter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.importer.get_module_members()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate._simple_info()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate._simple_warn()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html.HTMLTranslator.permalink_text</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html5.HTML5Translator.permalink_text</span></code></p></li>
</ul>
</section>
<section id="id659">
<h3>Features added<a class="headerlink" href="#id659" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8022">#8022</a>: autodoc: autodata and autoattribute directives does not show right-hand
value of the variable if docstring contains <code class="docutils literal notranslate"><span class="pre">:meta</span> <span class="pre">hide-value:</span></code> in
info-field-list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8514">#8514</a>: autodoc: Default values of overloaded functions are taken from actual
implementation if they’re ellipsis</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8775">#8775</a>: autodoc: Support type union operator (PEP-604) in Python 3.10 or above</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8297">#8297</a>: autodoc: Allow to extend <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_default_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_default_options</span></code></a> via
directive options</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/759">#759</a>: autodoc: Add a new configuration <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_preserve_defaults"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_preserve_defaults</span></code></a> as
an experimental feature. It preserves the default argument values of
functions in source code and keep them not evaluated for readability.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8619">#8619</a>: html: kbd role generates customizable HTML tags for compound keys</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8634">#8634</a>: html: Allow to change the order of JS/CSS via <code class="docutils literal notranslate"><span class="pre">priority</span></code> parameter
for <a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.add_js_file" title="sphinx.application.Sphinx.add_js_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Sphinx.add_js_file()</span></code></a> and <a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.add_css_file" title="sphinx.application.Sphinx.add_css_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Sphinx.add_css_file()</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6241">#6241</a>: html: Allow to add JS/CSS files to the specific page when an extension
calls <code class="docutils literal notranslate"><span class="pre">app.add_js_file()</span></code> or <code class="docutils literal notranslate"><span class="pre">app.add_css_file()</span></code> on
<a class="reference internal" href="extdev/appapi.html#event-html-page-context"><code class="xref std std-event docutils literal notranslate"><span class="pre">html-page-context</span></code></a> event</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6550">#6550</a>: html: Allow to use HTML permalink texts via
<a class="reference internal" href="usage/configuration.html#confval-html_permalinks_icon"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_permalinks_icon</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1638">#1638</a>: html: Add permalink icons to glossary terms</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8868">#8868</a>: html search: performance issue with massive lists</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8867">#8867</a>: html search: Update JavaScript stemmer code to the latest version of
Snowball (v2.1.0)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8852">#8852</a>: i18n: Allow to translate heading syntax in MyST-Parser</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8649">#8649</a>: imgconverter: Skip availability check if builder supports the image
type</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8573">#8573</a>: napoleon: Allow to change the style of custom sections using
<a class="reference internal" href="usage/extensions/napoleon.html#confval-napoleon_custom_sections"><code class="xref std std-confval docutils literal notranslate"><span class="pre">napoleon_custom_sections</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8004">#8004</a>: napoleon: Type definitions in Google style docstrings are rendered as
references when <a class="reference internal" href="usage/extensions/napoleon.html#confval-napoleon_preprocess_types"><code class="xref std std-confval docutils literal notranslate"><span class="pre">napoleon_preprocess_types</span></code></a> enabled</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6241">#6241</a>: mathjax: Include mathjax.js only on the document using equations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8775">#8775</a>: py domain: Support type union operator (PEP-604)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8651">#8651</a>: std domain: cross-reference for a rubric having inline item is broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7642">#7642</a>: std domain: Optimize case-insensitive match of term</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8681">#8681</a>: viewcode: Support incremental build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8132">#8132</a>: Add <a class="reference internal" href="usage/configuration.html#confval-project_copyright"><code class="xref std std-confval docutils literal notranslate"><span class="pre">project_copyright</span></code></a> as an alias of <a class="reference internal" href="usage/configuration.html#confval-copyright"><code class="xref std std-confval docutils literal notranslate"><span class="pre">copyright</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/207">#207</a>: Now <a class="reference internal" href="usage/configuration.html#confval-highlight_language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">highlight_language</span></code></a> supports multiple languages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2030">#2030</a>: <a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a> and <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> supports automatic
dedent via no-argument <code class="docutils literal notranslate"><span class="pre">:dedent:</span></code> option</p></li>
<li><p>C++, also hyperlink operator overloads in expressions and alias declarations.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8247">#8247</a>: Allow production lists to refer to tokens from other production groups</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8813">#8813</a>: Show what extension (or module) caused it on errors on event handler</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8213">#8213</a>: C++: add <code class="docutils literal notranslate"><span class="pre">maxdepth</span></code> option to <a class="reference internal" href="usage/restructuredtext/domains.html#directive-cpp-alias" title="cpp:alias directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">cpp:alias</span></code></a> to insert nested
declarations.</p></li>
<li><p>C, add <code class="docutils literal notranslate"><span class="pre">noroot</span></code> option to <a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-alias" title="c:alias directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:alias</span></code></a> to render only nested
declarations.</p></li>
<li><p>C++, add <code class="docutils literal notranslate"><span class="pre">noroot</span></code> option to <a class="reference internal" href="usage/restructuredtext/domains.html#directive-cpp-alias" title="cpp:alias directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">cpp:alias</span></code></a> to render only nested
declarations.</p></li>
</ul>
</section>
<section id="id687">
<h3>Bugs fixed<a class="headerlink" href="#id687" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8727">#8727</a>: apidoc: namespace module file is not generated if no submodules there</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/741">#741</a>: autodoc: inherited-members doesn’t work for instance attributes on super
class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8592">#8592</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">:meta</span> <span class="pre">public:</span></code> does not effect to variables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8594">#8594</a>: autodoc: empty __all__ attribute is ignored</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8315">#8315</a>: autodoc: Failed to resolve struct.Struct type annotation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8652">#8652</a>: autodoc: All variable comments in the module are ignored if the module
contains invalid type comments</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8693">#8693</a>: autodoc: Default values for overloaded functions are rendered as string</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8134">#8134</a>: autodoc: crashes when mocked decorator takes arguments</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8800">#8800</a>: autodoc: Uninitialized attributes in superclass are recognized as
undocumented</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8655">#8655</a>: autodoc: Failed to generate document if target module contains an
object that raises an exception on <code class="docutils literal notranslate"><span class="pre">hasattr()</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8306">#8306</a>: autosummary: mocked modules are documented as empty page when using
:recursive: option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8232">#8232</a>: graphviz: Image node is not rendered if graph file is in subdirectory</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8618">#8618</a>: html: kbd role produces incorrect HTML when compound-key separators (-,
+ or ^) are used as keystrokes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8629">#8629</a>: html: A type warning for html_use_opensearch is shown twice</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8714">#8714</a>: html: kbd role with “Caps Lock” rendered incorrectly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8123">#8123</a>: html search: fix searching for terms containing + (Requires a custom
search language that does not split on +)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8665">#8665</a>: html theme: Could not override globaltoc_maxdepth in theme.conf</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8446">#8446</a>: html: consecutive spaces are displayed as single space</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8745">#8745</a>: i18n: crashes with KeyError when translation message adds a new auto
footnote reference</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4304">#4304</a>: linkcheck: Fix race condition that could lead to checking the
availability of the same URL twice</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8791">#8791</a>: linkcheck: The docname for each hyperlink is not displayed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7118">#7118</a>: sphinx-quickstart: questionare got Mojibake if libreadline unavailable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8094">#8094</a>: texinfo: image files on the different directory with document are not
copied</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8782">#8782</a>: todo: Cross references in todolist get broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8720">#8720</a>: viewcode: module pages are generated for epub on incremental build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8704">#8704</a>: viewcode: anchors are generated in incremental build after singlehtml</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8756">#8756</a>: viewcode: highlighted code is generated even if not referenced</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8671">#8671</a>: <a class="reference internal" href="usage/configuration.html#confval-highlight_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">highlight_options</span></code></a> is not working</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8341">#8341</a>: C, fix intersphinx lookup types for names in declarations.</p></li>
<li><p>C, C++: in general fix intersphinx and role lookup types.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8683">#8683</a>: <a class="reference internal" href="usage/configuration.html#confval-html_last_updated_fmt"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_last_updated_fmt</span></code></a> does not support UTC offset (%z)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8683">#8683</a>: <a class="reference internal" href="usage/configuration.html#confval-html_last_updated_fmt"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_last_updated_fmt</span></code></a> generates wrong time zone for %Z</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1112">#1112</a>: <code class="docutils literal notranslate"><span class="pre">download</span></code> role creates duplicated copies when relative path is
specified</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2616">#2616</a> (fifth item): LaTeX: footnotes from captions are not clickable,
and for manually numbered footnotes only first one with same number is
an hyperlink</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7576">#7576</a>: LaTeX with French babel and memoir crash: “Illegal parameter number
in definition of <code class="docutils literal notranslate"><span class="pre">\FNH@prefntext</span></code>”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8055">#8055</a>: LaTeX (docs): A potential display bug with the LaTeX generation step
in Sphinx (how to generate one-column index)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8072">#8072</a>: LaTeX: Directive <a class="reference internal" href="usage/restructuredtext/directives.html#directive-hlist" title="hlist directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">hlist</span></code></a> not implemented in LaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8214">#8214</a>: LaTeX: The <a class="reference internal" href="usage/restructuredtext/directives.html#role-index" title="index role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">index</span></code></a> role and the glossary generate duplicate
entries in the LaTeX index (if both used for same term)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8735">#8735</a>: LaTeX: wrong internal links in pdf to captioned code-blocks when
<a class="reference internal" href="usage/configuration.html#confval-numfig"><code class="xref std std-confval docutils literal notranslate"><span class="pre">numfig</span></code></a> is not True</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8442">#8442</a>: LaTeX: some indexed terms are ignored when using xelatex engine
(or pdflatex and <a class="reference internal" href="usage/configuration.html#confval-latex_use_xindy"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_use_xindy</span></code></a> set to True) with memoir class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8750">#8750</a>: LaTeX: URLs as footnotes fail to show in PDF if originating from
inside function type signatures</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8780">#8780</a>: LaTeX: long words in narrow columns may not be hyphenated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8788">#8788</a>: LaTeX: <code class="docutils literal notranslate"><span class="pre">\titleformat</span></code> last argument in sphinx.sty should be
bracketed, not braced (and is anyhow not needed)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8849">#8849</a>: LaTex: code-block printed out of margin (see the opt-in LaTeX syntax
boolean <a class="reference internal" href="latex.html#latexsphinxsetupforcewraps"><span class="std std-ref">verbatimforcewraps</span></a> for use via
the <a class="reference internal" href="latex.html#latexsphinxsetup"><span class="std std-ref">‘sphinxsetup’</span></a> key of <code class="docutils literal notranslate"><span class="pre">latex_elements</span></code>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8183">#8183</a>: LaTeX: Remove substitution_reference nodes from doctree only on LaTeX
builds</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8865">#8865</a>: LaTeX: Restructure the index nodes inside title nodes only on LaTeX
builds</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8796">#8796</a>: LaTeX: potentially critical low level TeX coding mistake has gone
unnoticed so far</p></li>
<li><p>C, <a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-alias" title="c:alias directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:alias</span></code></a> skip symbols without explicit declarations
instead of crashing.</p></li>
<li><p>C, <a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-alias" title="c:alias directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:alias</span></code></a> give a warning when the root symbol is not declared.</p></li>
<li><p>C, <code class="docutils literal notranslate"><span class="pre">expr</span></code> role should start symbol lookup in the current scope.</p></li>
</ul>
</section>
</section>
<section id="release-3-4-3-released-jan-08-2021">
<h2>Release 3.4.3 (released Jan 08, 2021)<a class="headerlink" href="#release-3-4-3-released-jan-08-2021" title="Link to this heading">¶</a></h2>
<section id="id734">
<h3>Bugs fixed<a class="headerlink" href="#id734" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8655">#8655</a>: autodoc: Failed to generate document if target module contains an
object that raises an exception on <code class="docutils literal notranslate"><span class="pre">hasattr()</span></code></p></li>
</ul>
</section>
</section>
<section id="release-3-4-2-released-jan-04-2021">
<h2>Release 3.4.2 (released Jan 04, 2021)<a class="headerlink" href="#release-3-4-2-released-jan-04-2021" title="Link to this heading">¶</a></h2>
<section id="id736">
<h3>Bugs fixed<a class="headerlink" href="#id736" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8164">#8164</a>: autodoc: Classes that inherit mocked class are not documented</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8602">#8602</a>: autodoc: The <code class="docutils literal notranslate"><span class="pre">autodoc-process-docstring</span></code> event is emitted to the
non-datadescriptors unexpectedly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8616">#8616</a>: autodoc: AttributeError is raised on non-class object is passed to
autoclass directive</p></li>
</ul>
</section>
</section>
<section id="release-3-4-1-released-dec-25-2020">
<h2>Release 3.4.1 (released Dec 25, 2020)<a class="headerlink" href="#release-3-4-1-released-dec-25-2020" title="Link to this heading">¶</a></h2>
<section id="id740">
<h3>Bugs fixed<a class="headerlink" href="#id740" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8559">#8559</a>: autodoc: AttributeError is raised when using forward-reference type
annotations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8568">#8568</a>: autodoc: TypeError is raised on checking slots attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8567">#8567</a>: autodoc: Instance attributes are incorrectly added to Parent class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8566">#8566</a>: autodoc: The <code class="docutils literal notranslate"><span class="pre">autodoc-process-docstring</span></code> event is emitted to the
alias classes unexpectedly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8583">#8583</a>: autodoc: Unnecessary object comparison via <code class="docutils literal notranslate"><span class="pre">__eq__</span></code> method</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8565">#8565</a>: linkcheck: Fix PriorityQueue crash when link tuples are not
comparable</p></li>
</ul>
</section>
</section>
<section id="release-3-4-0-released-dec-20-2020">
<h2>Release 3.4.0 (released Dec 20, 2020)<a class="headerlink" href="#release-3-4-0-released-dec-20-2020" title="Link to this heading">¶</a></h2>
<section id="id747">
<h3>Incompatible changes<a class="headerlink" href="#id747" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8105">#8105</a>: autodoc: the signature of class constructor will be shown for decorated
classes, not a signature of decorator</p></li>
</ul>
</section>
<section id="id749">
<h3>Deprecated<a class="headerlink" href="#id749" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>The <code class="docutils literal notranslate"><span class="pre">follow_wrapped</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.util.inspect.signature()</span></code></p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">no_docstring</span></code> argument of
<code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.Documenter.add_content()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.Documenter.get_object_members()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.DataDeclarationDocumenter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.GenericAliasDocumenter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.InstanceAttributeDocumenter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.SlotsAttributeDocumenter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.TypeVarDocumenter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.importer._getannotations()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.importer._getmro()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.pycode.ModuleAnalyzer.parse()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.osutil.movefile()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.requests.is_ssl_error()</span></code></p></li>
</ul>
</section>
<section id="id750">
<h3>Features added<a class="headerlink" href="#id750" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8119">#8119</a>: autodoc: Allow to determine whether a member not included in
<code class="docutils literal notranslate"><span class="pre">__all__</span></code> attribute of the module should be documented or not via
<a class="reference internal" href="usage/extensions/autodoc.html#event-autodoc-skip-member"><code class="xref std std-event docutils literal notranslate"><span class="pre">autodoc-skip-member</span></code></a> event</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8219">#8219</a>: autodoc: Parameters for generic class are not shown when super class is
a generic class and show-inheritance option is given (in Python 3.7 or above)</p></li>
<li><p>autodoc: Add <code class="docutils literal notranslate"><span class="pre">Documenter.config</span></code> as a shortcut to access the config object</p></li>
<li><p>autodoc: Add Optional[t] to annotation of function and method if a default
value equal to None is set.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8209">#8209</a>: autodoc: Add <code class="docutils literal notranslate"><span class="pre">:no-value:</span></code> option to <a class="reference internal" href="usage/extensions/autodoc.html#directive-autoattribute" title="autoattribute directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">autoattribute</span></code></a> and
<a class="reference internal" href="usage/extensions/autodoc.html#directive-autodata" title="autodata directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">autodata</span></code></a> directive to suppress the default value of the variable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8460">#8460</a>: autodoc: Support custom types defined by typing.NewType</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8285">#8285</a>: napoleon: Add <a class="reference internal" href="usage/extensions/napoleon.html#confval-napoleon_attr_annotations"><code class="xref std std-confval docutils literal notranslate"><span class="pre">napoleon_attr_annotations</span></code></a> to merge type hints
on source code automatically if any type is specified in docstring</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8236">#8236</a>: napoleon: Support numpydoc’s “Receives” section</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6914">#6914</a>: Add a new event <a class="reference internal" href="extdev/appapi.html#event-warn-missing-reference"><code class="xref std std-event docutils literal notranslate"><span class="pre">warn-missing-reference</span></code></a> to custom warning
messages when failed to resolve a cross-reference</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6914">#6914</a>: Emit a detailed warning when failed to resolve a <code class="docutils literal notranslate"><span class="pre">:ref:</span></code> reference</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6629">#6629</a>: linkcheck: The builder now handles rate limits. See
<a class="reference internal" href="usage/configuration.html#confval-linkcheck_rate_limit_timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_rate_limit_timeout</span></code></a> for details.</p></li>
</ul>
</section>
<section id="id760">
<h3>Bugs fixed<a class="headerlink" href="#id760" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7613">#7613</a>: autodoc: autodoc does not respect __signature__ of the class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4606">#4606</a>: autodoc: the location of the warning is incorrect for inherited method</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8105">#8105</a>: autodoc: the signature of class constructor is incorrect if the class
is decorated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8434">#8434</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_type_aliases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_type_aliases</span></code></a> does not effect to variables
and attributes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8443">#8443</a>: autodoc: autodata directive can’t create document for PEP-526 based
type annotated variables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8443">#8443</a>: autodoc: autoattribute directive can’t create document for PEP-526
based uninitialized variables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8480">#8480</a>: autodoc: autoattribute could not create document for __slots__
attributes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8503">#8503</a>: autodoc: autoattribute could not create document for a GenericAlias as
class attributes correctly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8534">#8534</a>: autodoc: autoattribute could not create document for a commented
attribute in alias class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8452">#8452</a>: autodoc: autodoc_type_aliases doesn’t work when autodoc_typehints is
set to “description”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8541">#8541</a>: autodoc: autodoc_type_aliases doesn’t work for the type annotation to
instance attributes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8460">#8460</a>: autodoc: autodata and autoattribute directives do not display type
information of TypeVars</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8493">#8493</a>: autodoc: references to builtins not working in class aliases</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8522">#8522</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">__bool__</span></code> method could be called</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8067">#8067</a>: autodoc: A typehint for the instance variable having type_comment on
super class is not displayed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8545">#8545</a>: autodoc: a __slots__ attribute is not documented even having docstring</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/741">#741</a>: autodoc: inherited-members doesn’t work for instance attributes on super
class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8477">#8477</a>: autosummary: non utf-8 reST files are generated when template contains
multibyte characters</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8501">#8501</a>: autosummary: summary extraction splits text after “el at.” unexpectedly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8524">#8524</a>: html: Wrong url_root has been generated on a document named “index”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8419">#8419</a>: html search: Do not load <code class="docutils literal notranslate"><span class="pre">language_data.js</span></code> in non-search pages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8549">#8549</a>: i18n: <code class="docutils literal notranslate"><span class="pre">-D</span> <span class="pre">gettext_compact=0</span></code> is no longer working</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8454">#8454</a>: graphviz: The layout option for graph and digraph directives don’t work</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8131">#8131</a>: linkcheck: Use GET when HEAD requests cause Too Many Redirects, to
accommodate infinite redirect loops on HEAD</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8437">#8437</a>: Makefile: <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code> with empty BUILDDIR is dangerous</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8365">#8365</a>: py domain: <code class="docutils literal notranslate"><span class="pre">:type:</span></code> and <code class="docutils literal notranslate"><span class="pre">:rtype:</span></code> gives false ambiguous class
lookup warnings</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8352">#8352</a>: std domain: Failed to parse an option that starts with bracket</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8519">#8519</a>: LaTeX: Prevent page brake in the middle of a seealso</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8520">#8520</a>: C, fix copying of AliasNode.</p></li>
</ul>
</section>
</section>
<section id="release-3-3-1-released-nov-12-2020">
<h2>Release 3.3.1 (released Nov 12, 2020)<a class="headerlink" href="#release-3-3-1-released-nov-12-2020" title="Link to this heading">¶</a></h2>
<section id="id790">
<h3>Bugs fixed<a class="headerlink" href="#id790" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8372">#8372</a>: autodoc: autoclass directive became slower than Sphinx 3.2</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7727">#7727</a>: autosummary: raise PycodeError when documenting python package
without __init__.py</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8350">#8350</a>: autosummary: autosummary_mock_imports causes slow down builds</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8364">#8364</a>: C, properly initialize attributes in empty symbols.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8399">#8399</a>: i18n: Put system locale path after the paths specified by configuration</p></li>
</ul>
</section>
</section>
<section id="release-3-3-0-released-nov-02-2020">
<h2>Release 3.3.0 (released Nov 02, 2020)<a class="headerlink" href="#release-3-3-0-released-nov-02-2020" title="Link to this heading">¶</a></h2>
<section id="id796">
<h3>Deprecated<a class="headerlink" href="#id796" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.latex.LaTeXBuilder.usepackages</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.SingledispatchFunctionDocumenter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.SingledispatchMethodDocumenter</span></code></p></li>
</ul>
</section>
<section id="id797">
<h3>Features added<a class="headerlink" href="#id797" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8100">#8100</a>: html: Show a better error message for failures on copying
html_static_files</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8141">#8141</a>: C: added a <code class="docutils literal notranslate"><span class="pre">maxdepth</span></code> option to <a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-alias" title="c:alias directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:alias</span></code></a> to insert
nested declarations.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8081">#8081</a>: LaTeX: Allow to add LaTeX package via <code class="docutils literal notranslate"><span class="pre">app.add_latex_package()</span></code> until
just before writing .tex file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7996">#7996</a>: manpage: Add <a class="reference internal" href="usage/configuration.html#confval-man_make_section_directory"><code class="xref std std-confval docutils literal notranslate"><span class="pre">man_make_section_directory</span></code></a> to make a section
directory on build man page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8289">#8289</a>: epub: Allow to suppress “duplicated ToC entry found” warnings from epub
builder using <a class="reference internal" href="usage/configuration.html#confval-suppress_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">suppress_warnings</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8298">#8298</a>: sphinx-quickstart: Add <a class="reference internal" href="man/sphinx-quickstart.html#cmdoption-sphinx-quickstart-no-sep"><code class="xref std std-option docutils literal notranslate"><span class="pre">sphinx-quickstart</span> <span class="pre">--no-sep</span></code></a> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8304">#8304</a>: sphinx.testing: Register public markers in sphinx.testing.fixtures</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8051">#8051</a>: napoleon: use the obj role for all See Also items</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8050">#8050</a>: napoleon: Apply <a class="reference internal" href="usage/extensions/napoleon.html#confval-napoleon_preprocess_types"><code class="xref std std-confval docutils literal notranslate"><span class="pre">napoleon_preprocess_types</span></code></a> to every field</p></li>
<li><p>C and C++, show line numbers for previous declarations when duplicates are
detected.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8183">#8183</a>: Remove substitution_reference nodes from doctree only on LaTeX builds</p></li>
</ul>
</section>
<section id="id808">
<h3>Bugs fixed<a class="headerlink" href="#id808" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8085">#8085</a>: i18n: Add support for having single text domain</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6640">#6640</a>: i18n: Failed to override system message translation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8143">#8143</a>: autodoc: AttributeError is raised when False value is passed to
autodoc_default_options</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8103">#8103</a>: autodoc: functools.cached_property is not considered as a property</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8190">#8190</a>: autodoc: parsing error is raised if some extension replaces docstring
by string not ending with blank lines</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8142">#8142</a>: autodoc: Wrong constructor signature for the class derived from
typing.Generic</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8157">#8157</a>: autodoc: TypeError is raised when annotation has invalid __args__</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7964">#7964</a>: autodoc: Tuple in default value is wrongly rendered</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8200">#8200</a>: autodoc: type aliases break type formatting of autoattribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7786">#7786</a>: autodoc: can’t detect overloaded methods defined in other file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8294">#8294</a>: autodoc: single-string __slots__ is not handled correctly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7785">#7785</a>: autodoc: autodoc_typehints=’none’ does not effect to overloaded functions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8192">#8192</a>: napoleon: description is disappeared when it contains inline literals</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8142">#8142</a>: napoleon: Potential of regex denial of service in google style docs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8169">#8169</a>: LaTeX: pxjahyper loaded even when latex_engine is not platex</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8215">#8215</a>: LaTeX: ‘oneside’ classoption causes build warning</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8175">#8175</a>: intersphinx: Potential of regex denial of service by broken inventory</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8277">#8277</a>: sphinx-build: missing and redundant spacing (and etc) for console
output on building</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7973">#7973</a>: imgconverter: Check availability of imagemagick many times</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8255">#8255</a>: py domain: number in default argument value is changed from hexadecimal
to decimal</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8316">#8316</a>: html: Prevent arrow keys changing page when button elements are focused</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8343">#8343</a>: html search: Fix unnecessary load of images when parsing the document</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8254">#8254</a>: html theme: Line numbers misalign with code lines</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8093">#8093</a>: The highlight warning has wrong location in some builders (LaTeX,
singlehtml and so on)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8215">#8215</a>: Eliminate Fancyhdr build warnings for oneside documents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8239">#8239</a>: Failed to refer a token in productionlist if it is indented</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8268">#8268</a>: linkcheck: Report HTTP errors when <code class="docutils literal notranslate"><span class="pre">linkcheck_anchors</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8245">#8245</a>: linkcheck: take source directory into account for local files</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8321">#8321</a>: linkcheck: <code class="docutils literal notranslate"><span class="pre">tel:</span></code> schema hyperlinks are detected as errors</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8323">#8323</a>: linkcheck: An exit status is incorrect when links having unsupported
schema found</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8188">#8188</a>: C, add missing items to internal object types dictionary,
e.g., preventing intersphinx from resolving them.</p></li>
<li><p>C, fix anon objects in intersphinx.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8270">#8270</a>, C++, properly reject functions as duplicate declarations if a
non-function declaration of the same name already exists.</p></li>
<li><p>C, fix references to function parameters.
Link to the function instead of a non-existing anchor.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6914">#6914</a>: figure numbers are unexpectedly assigned to uncaptioned items</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8320">#8320</a>: make “inline” line numbers un-selectable</p></li>
</ul>
</section>
<section id="id843">
<h3>Testing<a class="headerlink" href="#id843" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8257">#8257</a>: Support parallel build in sphinx.testing</p></li>
</ul>
</section>
</section>
<section id="release-3-2-1-released-aug-14-2020">
<h2>Release 3.2.1 (released Aug 14, 2020)<a class="headerlink" href="#release-3-2-1-released-aug-14-2020" title="Link to this heading">¶</a></h2>
<section id="id845">
<h3>Features added<a class="headerlink" href="#id845" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8095">#8095</a>: napoleon: Add <a class="reference internal" href="usage/extensions/napoleon.html#confval-napoleon_preprocess_types"><code class="xref std std-confval docutils literal notranslate"><span class="pre">napoleon_preprocess_types</span></code></a> to enable the type
preprocessor for numpy style docstrings</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8114">#8114</a>: C and C++, parse function attributes after parameters and qualifiers.</p></li>
</ul>
</section>
<section id="id848">
<h3>Bugs fixed<a class="headerlink" href="#id848" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8074">#8074</a>: napoleon: Crashes during processing C-ext module</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8088">#8088</a>: napoleon: “Inline literal start-string without end-string” warning in
Numpy style Parameters section</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8084">#8084</a>: autodoc: KeyError is raised on documenting an attribute of the broken
class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8091">#8091</a>: autodoc: AttributeError is raised on documenting an attribute on Python
3.5.2</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8099">#8099</a>: autodoc: NameError is raised when target code uses <code class="docutils literal notranslate"><span class="pre">TYPE_CHECKING</span></code></p></li>
<li><p>C++, fix parsing of template template parameters, broken by the fix of <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7944">#7944</a></p></li>
</ul>
</section>
</section>
<section id="release-3-2-0-released-aug-08-2020">
<h2>Release 3.2.0 (released Aug 08, 2020)<a class="headerlink" href="#release-3-2-0-released-aug-08-2020" title="Link to this heading">¶</a></h2>
<section id="id855">
<h3>Deprecated<a class="headerlink" href="#id855" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.members_set_option()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.merge_special_members_option()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.texinfo.TexinfoWriter.desc</span></code></p></li>
<li><p>C, parsing of pre-v3 style type directives and roles, along with the options
<code class="xref std std-confval docutils literal notranslate"><span class="pre">c_allow_pre_v3</span></code> and <code class="xref std std-confval docutils literal notranslate"><span class="pre">c_warn_on_allowed_pre_v3</span></code>.</p></li>
</ul>
</section>
<section id="id856">
<h3>Features added<a class="headerlink" href="#id856" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2076">#2076</a>: autodoc: Allow overriding of exclude-members in skip-member function</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8034">#8034</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">:private-member:</span></code> can take an explicit list of member names
to be documented</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2024">#2024</a>: autosummary: Add <a class="reference internal" href="usage/extensions/autosummary.html#confval-autosummary_filename_map"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosummary_filename_map</span></code></a> to avoid conflict
of filenames between two object with different case</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8011">#8011</a>: autosummary: Support instance attributes as a target of autosummary
directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7849">#7849</a>: html: Add <a class="reference internal" href="usage/configuration.html#confval-html_codeblock_linenos_style"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_codeblock_linenos_style</span></code></a> to change the style
of line numbers for code-blocks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7853">#7853</a>: C and C++, support parameterized GNU style attributes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7888">#7888</a>: napoleon: Add aliases Warn and Raise.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7690">#7690</a>: napoleon: parse type strings and make them hyperlinks as possible. The
conversion rule can be updated via <a class="reference internal" href="usage/extensions/napoleon.html#confval-napoleon_type_aliases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">napoleon_type_aliases</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8049">#8049</a>: napoleon: Create a hyperlink for each the type of parameter when
<a class="reference internal" href="usage/extensions/napoleon.html#confval-napoleon_use_param"><code class="xref std std-confval docutils literal notranslate"><span class="pre">napoleon_use_param</span></code></a> is False</p></li>
<li><p>C, added <a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-alias" title="c:alias directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:alias</span></code></a> directive for inserting copies
of existing declarations.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7745">#7745</a>: html: inventory is broken if the docname contains a space</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7991">#7991</a>: html search: Allow searching for numbers</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7902">#7902</a>: html theme: Add a new option <code class="xref std std-confval docutils literal notranslate"><span class="pre">globaltoc_maxdepth</span></code> to control
the behavior of globaltoc in sidebar</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7840">#7840</a>: i18n: Optimize the dependencies check on bootstrap</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7768">#7768</a>: i18n: <a class="reference internal" href="usage/configuration.html#confval-figure_language_filename"><code class="xref std std-confval docutils literal notranslate"><span class="pre">figure_language_filename</span></code></a> supports <code class="docutils literal notranslate"><span class="pre">docpath</span></code> token</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5208">#5208</a>: linkcheck: Support checks for local links</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5090">#5090</a>: setuptools: Link verbosity to distutils’ -v and -q option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6698">#6698</a>: doctest: Add <code class="docutils literal notranslate"><span class="pre">:trim-doctest-flags:</span></code> and <code class="docutils literal notranslate"><span class="pre">:no-trim-doctest-flags:</span></code>
options to doctest, testcode and testoutput directives</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7052">#7052</a>: add <code class="docutils literal notranslate"><span class="pre">:noindexentry:</span></code> to the Python, C, C++, and Javascript domains.
Update the documentation to better reflect the relationship between this option
and the <code class="docutils literal notranslate"><span class="pre">:noindex:</span></code> option.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7899">#7899</a>: C, add possibility of parsing of some pre-v3 style type directives and
roles and try to convert them to equivalent v3 directives/roles.
Set the new option <code class="xref std std-confval docutils literal notranslate"><span class="pre">c_allow_pre_v3</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code> to enable this.
The warnings printed from this functionality can be suppressed by setting
<code class="xref std std-confval docutils literal notranslate"><span class="pre">c_warn_on_allowed_pre_v3</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code>.
The functionality is immediately deprecated.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7999">#7999</a>: C, add support for named variadic macro arguments.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8071">#8071</a>: Allow to suppress “self referenced toctrees” warning</p></li>
</ul>
</section>
<section id="id878">
<h3>Bugs fixed<a class="headerlink" href="#id878" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7886">#7886</a>: autodoc: TypeError is raised on mocking generic-typed classes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7935">#7935</a>: autodoc: function signature is not shown when the function has a
parameter having <code class="docutils literal notranslate"><span class="pre">inspect._empty</span></code> as its default value</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7901">#7901</a>: autodoc: type annotations for overloaded functions are not resolved</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/904">#904</a>: autodoc: An instance attribute cause a crash of autofunction directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1362">#1362</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">private-members</span></code> option does not work for class attributes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7983">#7983</a>: autodoc: Generator type annotation is wrongly rendered in py36</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8030">#8030</a>: autodoc: An uninitialized annotated instance variable is not documented
when <code class="docutils literal notranslate"><span class="pre">:inherited-members:</span></code> option given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8032">#8032</a>: autodoc: A type hint for the instance variable defined at parent class
is not shown in the document of the derived class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8041">#8041</a>: autodoc: An annotated instance variable on super class is not
documented when derived class has other annotated instance variables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7839">#7839</a>: autosummary: cannot handle umlauts in function names</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7865">#7865</a>: autosummary: Failed to extract summary line when abbreviations found</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7866">#7866</a>: autosummary: Failed to extract correct summary line when docstring
contains a hyperlink target</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7469">#7469</a>: autosummary: “Module attributes” header is not translatable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7940">#7940</a>: apidoc: An extra newline is generated at the end of the rst file if a
module has submodules</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4258">#4258</a>: napoleon: decorated special methods are not shown</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7799">#7799</a>: napoleon: parameters are not escaped for combined params in numpydoc</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7780">#7780</a>: napoleon: multiple parameters declaration in numpydoc was wrongly
recognized when <code class="docutils literal notranslate"><span class="pre">napoleon_use_param=True</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7715">#7715</a>: LaTeX: <code class="docutils literal notranslate"><span class="pre">numfig_secnum_depth</span> <span class="pre">></span> <span class="pre">1</span></code> leads to wrong figure links</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7846">#7846</a>: html theme: XML-invalid files were generated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7894">#7894</a>: gettext: Wrong source info is shown when using rst_epilog</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7691">#7691</a>: linkcheck: HEAD requests are not used for checking</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4888">#4888</a>: i18n: Failed to add an explicit title to <code class="docutils literal notranslate"><span class="pre">:ref:</span></code> role on translation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7928">#7928</a>: py domain: failed to resolve a type annotation for the attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8008">#8008</a>: py domain: failed to parse a type annotation containing ellipsis</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7994">#7994</a>: std domain: option directive does not generate old node_id compatible
with 2.x or older</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7968">#7968</a>: i18n: The content of <code class="docutils literal notranslate"><span class="pre">math</span></code> directive is interpreted as reST on
translation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7768">#7768</a>: i18n: The <code class="docutils literal notranslate"><span class="pre">root</span></code> element for <a class="reference internal" href="usage/configuration.html#confval-figure_language_filename"><code class="xref std std-confval docutils literal notranslate"><span class="pre">figure_language_filename</span></code></a> is
not a path that user specifies in the document</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7993">#7993</a>: texinfo: TypeError is raised for nested object descriptions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7993">#7993</a>: texinfo: a warning not supporting desc_signature_line node is shown</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7869">#7869</a>: <a class="reference internal" href="usage/restructuredtext/roles.html#role-abbr" title="abbr role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">abbr</span></code></a> role without an explanation will show the explanation
from the previous abbr role</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8048">#8048</a>: graphviz: graphviz.css was copied on building non-HTML document</p></li>
<li><p>C and C++, removed <code class="docutils literal notranslate"><span class="pre">noindex</span></code> directive option as it did
nothing.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7619">#7619</a>: Duplicated node IDs are generated if node has multiple IDs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2050">#2050</a>: Symbols sections are appeared twice in the index page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/8017">#8017</a>: Fix circular import in sphinx.addnodes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7986">#7986</a>: CSS: make “highlight” selector more robust</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7944">#7944</a>: C++, parse non-type template parameters starting with
a dependent qualified name.</p></li>
<li><p>C, don’t deepcopy the entire symbol table and make a mess every time an
enumerator is handled.</p></li>
</ul>
</section>
</section>
<section id="release-3-1-2-released-jul-05-2020">
<h2>Release 3.1.2 (released Jul 05, 2020)<a class="headerlink" href="#release-3-1-2-released-jul-05-2020" title="Link to this heading">¶</a></h2>
<section id="id915">
<h3>Incompatible changes<a class="headerlink" href="#id915" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7650">#7650</a>: autodoc: the signature of base function will be shown for decorated
functions, not a signature of decorator</p></li>
</ul>
</section>
<section id="id917">
<h3>Bugs fixed<a class="headerlink" href="#id917" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7844">#7844</a>: autodoc: Failed to detect module when relative module name given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7856">#7856</a>: autodoc: AttributeError is raised when non-class object is given to
the autoclass directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7850">#7850</a>: autodoc: KeyError is raised for invalid mark up when autodoc_typehints
is ‘description’</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7812">#7812</a>: autodoc: crashed if the target name matches to both an attribute and
module that are same name</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7650">#7650</a>: autodoc: function signature becomes <code class="docutils literal notranslate"><span class="pre">(*args,</span> <span class="pre">**kwargs)</span></code> if the
function is decorated by generic decorator</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7812">#7812</a>: autosummary: generates broken stub files if the target code contains
an attribute and module that are same name</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7806">#7806</a>: viewcode: Failed to resolve viewcode references on 3rd party builders</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7838">#7838</a>: html theme: List items have extra vertical space</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7878">#7878</a>: html theme: Undesired interaction between “overflow” and “float”</p></li>
</ul>
</section>
</section>
<section id="release-3-1-1-released-jun-14-2020">
<h2>Release 3.1.1 (released Jun 14, 2020)<a class="headerlink" href="#release-3-1-1-released-jun-14-2020" title="Link to this heading">¶</a></h2>
<section id="id927">
<h3>Incompatible changes<a class="headerlink" href="#id927" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7808">#7808</a>: napoleon: a type for attribute are represented as typed field</p></li>
</ul>
</section>
<section id="id929">
<h3>Features added<a class="headerlink" href="#id929" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7807">#7807</a>: autodoc: Show detailed warning when type_comment is mismatched with its
signature</p></li>
</ul>
</section>
<section id="id931">
<h3>Bugs fixed<a class="headerlink" href="#id931" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7808">#7808</a>: autodoc: Warnings raised on variable and attribute type annotations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7802">#7802</a>: autodoc: EOFError is raised on parallel build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7821">#7821</a>: autodoc: TypeError is raised for overloaded C-ext function</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7805">#7805</a>: autodoc: an object which descriptors returns is unexpectedly documented</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7807">#7807</a>: autodoc: wrong signature is shown for the function using contextmanager</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7812">#7812</a>: autosummary: generates broken stub files if the target code contains
an attribute and module that are same name</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7808">#7808</a>: napoleon: Warnings raised on variable and attribute type annotations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7811">#7811</a>: sphinx.util.inspect causes circular import problem</p></li>
</ul>
</section>
</section>
<section id="release-3-1-0-released-jun-08-2020">
<h2>Release 3.1.0 (released Jun 08, 2020)<a class="headerlink" href="#release-3-1-0-released-jun-08-2020" title="Link to this heading">¶</a></h2>
<section id="id940">
<h3>Dependencies<a class="headerlink" href="#id940" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7746">#7746</a>: mathjax: Update to 2.7.5</p></li>
</ul>
</section>
<section id="id942">
<h3>Incompatible changes<a class="headerlink" href="#id942" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7477">#7477</a>: imgconverter: Invoke “magick convert” command by default on Windows</p></li>
</ul>
</section>
<section id="id944">
<h3>Deprecated<a class="headerlink" href="#id944" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>The first argument for sphinx.ext.autosummary.generate.AutosummaryRenderer has
been changed to Sphinx object</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate.AutosummaryRenderer</span></code> takes an object type
as an argument</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">ignore</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.Documenter.get_doc()</span></code></p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">template_dir</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate.</span>
<span class="pre">AutosummaryRenderer</span></code></p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">module</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate.</span>
<span class="pre">find_autosummary_in_docstring()</span></code></p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">builder</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate.</span>
<span class="pre">generate_autosummary_docs()</span></code></p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">template_dir</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate.</span>
<span class="pre">generate_autosummary_docs()</span></code></p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">ignore</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.util.docstring.prepare_docstring()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.rpartition()</span></code></p></li>
</ul>
</section>
<section id="id945">
<h3>Features added<a class="headerlink" href="#id945" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>LaTeX: Make the <code class="docutils literal notranslate"><span class="pre">toplevel_sectioning</span></code> setting optional in LaTeX theme</p></li>
<li><p>LaTeX: Allow to override papersize and pointsize from LaTeX themes</p></li>
<li><p>LaTeX: Add <a class="reference internal" href="usage/configuration.html#confval-latex_theme_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_theme_options</span></code></a> to override theme options</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7410">#7410</a>: Allow to suppress “circular toctree references detected” warnings using
<a class="reference internal" href="usage/configuration.html#confval-suppress_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">suppress_warnings</span></code></a></p></li>
<li><p>C, added scope control directives, <a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-namespace" title="c:namespace directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:namespace</span></code></a>,
<a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-namespace-push" title="c:namespace-push directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:namespace-push</span></code></a>, and <a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-namespace-pop" title="c:namespace-pop directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">c:namespace-pop</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2044">#2044</a>: autodoc: Suppress default value for instance attributes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7473">#7473</a>: autodoc: consider a member public if docstring contains
<code class="docutils literal notranslate"><span class="pre">:meta</span> <span class="pre">public:</span></code> in info-field-list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7487">#7487</a>: autodoc: Allow to generate docs for singledispatch functions by
py:autofunction</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7143">#7143</a>: autodoc: Support final classes and methods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7384">#7384</a>: autodoc: Support signatures defined by <code class="docutils literal notranslate"><span class="pre">__new__()</span></code>, metaclasses and
builtin base classes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2106">#2106</a>: autodoc: Support multiple signatures on docstring</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4422">#4422</a>: autodoc: Support GenericAlias in Python 3.7 or above</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3610">#3610</a>: autodoc: Support overloaded functions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7722">#7722</a>: autodoc: Support TypeVar</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7466">#7466</a>: autosummary: headings in generated documents are not translated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7490">#7490</a>: autosummary: Add <code class="docutils literal notranslate"><span class="pre">:caption:</span></code> option to autosummary directive to set a
caption to the toctree</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7469">#7469</a>: autosummary: Support module attributes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/248">#248</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6040">#6040</a>: autosummary: Add <code class="docutils literal notranslate"><span class="pre">:recursive:</span></code> option to autosummary directive
to generate stub files recursively</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4030">#4030</a>: autosummary: Add <a class="reference internal" href="usage/extensions/autosummary.html#confval-autosummary_context"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosummary_context</span></code></a> to add template
variables for custom templates</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7530">#7530</a>: html: Support nested <kbd> elements</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7481">#7481</a>: html theme: Add right margin to footnote/citation labels</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7482">#7482</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7717">#7717</a>: html theme: CSS spacing for code blocks with captions and line
numbers</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7443">#7443</a>: html theme: Add new options <code class="xref std std-confval docutils literal notranslate"><span class="pre">globaltoc_collapse</span></code> and
<code class="xref std std-confval docutils literal notranslate"><span class="pre">globaltoc_includehidden</span></code> to control the behavior of globaltoc in
sidebar</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7484">#7484</a>: html theme: Avoid clashes between sidebar and other blocks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7476">#7476</a>: html theme: Relbar breadcrumb should contain current page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7506">#7506</a>: html theme: A canonical URL is not escaped</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7533">#7533</a>: html theme: Avoid whitespace at the beginning of genindex.html</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7541">#7541</a>: html theme: Add a “clearer” at the end of the “body”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7542">#7542</a>: html theme: Make admonition/topic/sidebar scrollable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7543">#7543</a>: html theme: Add top and bottom margins to tables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7695">#7695</a>: html theme: Add viewport meta tag for basic theme</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7721">#7721</a>: html theme: classic: default codetextcolor/codebgcolor doesn’t override
Pygments</p></li>
<li><p>C and C++: allow semicolon in the end of declarations.</p></li>
<li><p>C++, parse parameterized noexcept specifiers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7294">#7294</a>: C++, parse expressions with user-defined literals.</p></li>
<li><p>C++, parse trailing return types.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7143">#7143</a>: py domain: Add <code class="docutils literal notranslate"><span class="pre">:final:</span></code> option to <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-class" title="py:class directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:class</span></code></a>,
<a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-exception" title="py:exception directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:exception</span></code></a> and <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-method" title="py:method directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:method</span></code></a> directives</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7596">#7596</a>: py domain: Change a type annotation for variables to a hyperlink</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7770">#7770</a>: std domain: <a class="reference internal" href="usage/restructuredtext/domains.html#directive-option" title="option directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">option</span></code></a> directive support arguments in the form
of <code class="docutils literal notranslate"><span class="pre">foo[=bar]</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7582">#7582</a>: napoleon: a type for attribute are represented like type annotation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7734">#7734</a>: napoleon: overescaped trailing underscore on attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7247">#7247</a>: linkcheck: Add <a class="reference internal" href="usage/configuration.html#confval-linkcheck_request_headers"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_request_headers</span></code></a> to send custom HTTP
headers for specific host</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7792">#7792</a>: setuptools: Support <code class="docutils literal notranslate"><span class="pre">--verbosity</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7683">#7683</a>: Add <code class="docutils literal notranslate"><span class="pre">allowed_exceptions</span></code> parameter to <code class="docutils literal notranslate"><span class="pre">Sphinx.emit()</span></code> to allow
handlers to raise specified exceptions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7295">#7295</a>: C++, parse (trailing) requires clauses.</p></li>
</ul>
</section>
<section id="id986">
<h3>Bugs fixed<a class="headerlink" href="#id986" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6703">#6703</a>: autodoc: incremental build does not work for imported objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7564">#7564</a>: autodoc: annotations not to be shown for descriptors</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6588">#6588</a>: autodoc: Decorated inherited method has no documentation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7469">#7469</a>: autodoc: The change of autodoc-process-docstring for variables is
cached unexpectedly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7559">#7559</a>: autodoc: misdetects a sync function is async</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6857">#6857</a>: autodoc: failed to detect a classmethod on Enum class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7562">#7562</a>: autodoc: a typehint contains spaces is wrongly rendered under
<a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints</span></code></a><code class="docutils literal notranslate"><span class="pre">='description'</span></code> mode</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7551">#7551</a>: autodoc: failed to import nested class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7362">#7362</a>: autodoc: does not render correct signatures for built-in functions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7654">#7654</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">Optional[Union[foo,</span> <span class="pre">bar]]</span></code> is presented as
<code class="docutils literal notranslate"><span class="pre">Union[foo,</span> <span class="pre">bar,</span> <span class="pre">None]</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7629">#7629</a>: autodoc: autofunction emits an unfriendly warning if an invalid object
specified</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7650">#7650</a>: autodoc: undecorated signature is shown for decorated functions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7676">#7676</a>: autodoc: typo in the default value of autodoc_member_order</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7676">#7676</a>: autodoc: wrong value for :member-order: option is ignored silently</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7676">#7676</a>: autodoc: member-order=”bysource” does not work for C module</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3673">#3673</a>: autodoc: member-order=”bysource” does not work for a module having
__all__</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7668">#7668</a>: autodoc: wrong retann value is passed to a handler of
autodoc-process-signature</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7711">#7711</a>: autodoc: fails with ValueError when processing numpy objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7791">#7791</a>: autodoc: TypeError is raised on documenting singledispatch function</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7551">#7551</a>: autosummary: a nested class is indexed as non-nested class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7661">#7661</a>: autosummary: autosummary directive emits warnings twices if failed to
import the target module</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7685">#7685</a>: autosummary: The template variable “members” contains imported members
even if <code class="xref std std-confval docutils literal notranslate"><span class="pre">autossummary_imported_members</span></code> is False</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7671">#7671</a>: autosummary: The location of import failure warning is missing</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7535">#7535</a>: sphinx-autogen: crashes when custom template uses inheritance</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7536">#7536</a>: sphinx-autogen: crashes when template uses i18n feature</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7781">#7781</a>: sphinx-build: Wrong error message when outdir is not directory</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7653">#7653</a>: sphinx-quickstart: Fix multiple directory creation for nested relpath</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2785">#2785</a>: html: Bad alignment of equation links</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7718">#7718</a>: html theme: some themes does not respect background color of Pygments
style (agogo, haiku, nature, pyramid, scrolls, sphinxdoc and traditional)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7544">#7544</a>: html theme: inconsistent padding in admonitions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7581">#7581</a>: napoleon: bad parsing of inline code in attribute docstrings</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7628">#7628</a>: imgconverter: runs imagemagick once unnecessary for builders not
supporting images</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7610">#7610</a>: incorrectly renders consecutive backslashes for docutils-0.16</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7646">#7646</a>: handle errors on event handlers</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4187">#4187</a>: LaTeX: EN DASH disappears from PDF bookmarks in Japanese documents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7701">#7701</a>: LaTeX: Anonymous indirect hyperlink target causes duplicated labels</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7723">#7723</a>: LaTeX: pdflatex crashed when URL contains a single quote</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7756">#7756</a>: py domain: The default value for positional only argument is not shown</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7760">#7760</a>: coverage: Add <a class="reference internal" href="usage/extensions/coverage.html#confval-coverage_show_missing_items"><code class="xref std std-confval docutils literal notranslate"><span class="pre">coverage_show_missing_items</span></code></a> to show coverage
result to console</p></li>
<li><p>C++, fix rendering and xrefs in nested names explicitly starting
in global scope, e.g., <code class="docutils literal notranslate"><span class="pre">::A::B</span></code>.</p></li>
<li><p>C, fix rendering and xrefs in nested names explicitly starting
in global scope, e.g., <code class="docutils literal notranslate"><span class="pre">.A.B</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7763">#7763</a>: C and C++, don’t crash during display stringification of unary
expressions and fold expressions.</p></li>
</ul>
</section>
</section>
<section id="release-3-0-4-released-may-27-2020">
<h2>Release 3.0.4 (released May 27, 2020)<a class="headerlink" href="#release-3-0-4-released-may-27-2020" title="Link to this heading">¶</a></h2>
<section id="id1027">
<h3>Bugs fixed<a class="headerlink" href="#id1027" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7567">#7567</a>: autodoc: parametrized types are shown twice for generic types</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7637">#7637</a>: autodoc: system defined TypeVars are shown in Python 3.9</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7696">#7696</a>: html: Updated jQuery version from 3.4.1 to 3.5.1 for security reasons</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7611">#7611</a>: md5 fails when OpenSSL FIPS is enabled</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7626">#7626</a>: release package does not contain <code class="docutils literal notranslate"><span class="pre">CODE_OF_CONDUCT</span></code></p></li>
</ul>
</section>
</section>
<section id="release-3-0-3-released-apr-26-2020">
<h2>Release 3.0.3 (released Apr 26, 2020)<a class="headerlink" href="#release-3-0-3-released-apr-26-2020" title="Link to this heading">¶</a></h2>
<section id="id1033">
<h3>Features added<a class="headerlink" href="#id1033" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>C, parse array declarators with static, qualifiers, and VLA specification.</p></li>
</ul>
</section>
<section id="id1034">
<h3>Bugs fixed<a class="headerlink" href="#id1034" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7516">#7516</a>: autodoc: crashes if target object raises an error on accessing
its attributes</p></li>
</ul>
</section>
</section>
<section id="release-3-0-2-released-apr-19-2020">
<h2>Release 3.0.2 (released Apr 19, 2020)<a class="headerlink" href="#release-3-0-2-released-apr-19-2020" title="Link to this heading">¶</a></h2>
<section id="id1036">
<h3>Features added<a class="headerlink" href="#id1036" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>C, parse attributes and add <a class="reference internal" href="usage/configuration.html#confval-c_id_attributes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">c_id_attributes</span></code></a>
and <a class="reference internal" href="usage/configuration.html#confval-c_paren_attributes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">c_paren_attributes</span></code></a> to support user-defined attributes.</p></li>
</ul>
</section>
<section id="id1037">
<h3>Bugs fixed<a class="headerlink" href="#id1037" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7461">#7461</a>: py domain: fails with IndexError for empty tuple in type annotation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7510">#7510</a>: py domain: keyword-only arguments are documented as having a default of
None</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7418">#7418</a>: std domain: <a class="reference internal" href="usage/restructuredtext/roles.html#role-term" title="term role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">term</span></code></a> role could not match case-insensitively</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7461">#7461</a>: autodoc: empty tuple in type annotation is not shown correctly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7479">#7479</a>: autodoc: Sphinx builds has been slower since 3.0.0 on mocking</p></li>
<li><p>C++, fix spacing issue in east-const declarations.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7414">#7414</a>: LaTeX: Xindy language options were incorrect</p></li>
<li><p>sphinx crashes with ImportError on python3.5.1</p></li>
</ul>
</section>
</section>
<section id="release-3-0-1-released-apr-11-2020">
<h2>Release 3.0.1 (released Apr 11, 2020)<a class="headerlink" href="#release-3-0-1-released-apr-11-2020" title="Link to this heading">¶</a></h2>
<section id="id1044">
<h3>Incompatible changes<a class="headerlink" href="#id1044" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7418">#7418</a>: std domain: <a class="reference internal" href="usage/restructuredtext/roles.html#role-term" title="term role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">term</span></code></a> role becomes case sensitive</p></li>
</ul>
</section>
<section id="id1046">
<h3>Bugs fixed<a class="headerlink" href="#id1046" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7428">#7428</a>: py domain: a reference to class <code class="docutils literal notranslate"><span class="pre">None</span></code> emits a nitpicky warning</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7445">#7445</a>: py domain: a return annotation <code class="docutils literal notranslate"><span class="pre">None</span></code> in the function signature is
not converted to a hyperlink when using intersphinx</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7418">#7418</a>: std domain: duplication warning for glossary terms is case insensitive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7438">#7438</a>: C++, fix merging overloaded functions in parallel builds.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7422">#7422</a>: autodoc: fails with ValueError when using autodoc_mock_imports</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7435">#7435</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints</span></code></a><code class="docutils literal notranslate"><span class="pre">='description'</span></code> doesn’t
suppress typehints in signature for classes/methods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7451">#7451</a>: autodoc: fails with AttributeError when an object returns non-string
object as a <code class="docutils literal notranslate"><span class="pre">__doc__</span></code> member</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7423">#7423</a>: crashed when giving a non-string object to logger</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7479">#7479</a>: html theme: Do not include xmlns attribute with HTML 5 doctype</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7426">#7426</a>: html theme: Escape some links in HTML templates</p></li>
</ul>
</section>
</section>
<section id="release-3-0-0-released-apr-06-2020">
<h2>Release 3.0.0 (released Apr 06, 2020)<a class="headerlink" href="#release-3-0-0-released-apr-06-2020" title="Link to this heading">¶</a></h2>
<section id="id1057">
<h3>Dependencies<a class="headerlink" href="#id1057" title="Link to this heading">¶</a></h3>
<p>3.0.0b1</p>
<ul class="simple">
<li><p>LaTeX: drop dependency on <strong class="program">extractbb</strong> for image inclusion in
Japanese documents as <code class="docutils literal notranslate"><span class="pre">.xbb</span></code> files are unneeded by <strong class="program">dvipdfmx</strong>
since TeXLive2015 (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6189">#6189</a>)</p></li>
<li><p>babel-2.0 or above is available (Unpinned)</p></li>
</ul>
</section>
<section id="id1059">
<h3>Incompatible changes<a class="headerlink" href="#id1059" title="Link to this heading">¶</a></h3>
<p>3.0.0b1</p>
<ul class="simple">
<li><p>Drop features and APIs deprecated in 1.8.x</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/247">#247</a>: autosummary: stub files are overwritten automatically by default. see
<a class="reference internal" href="usage/extensions/autosummary.html#confval-autosummary_generate_overwrite"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosummary_generate_overwrite</span></code></a> to change the behavior</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5923">#5923</a>: autodoc: the members of <code class="docutils literal notranslate"><span class="pre">object</span></code> class are not documented by default
when <code class="docutils literal notranslate"><span class="pre">:inherited-members:</span></code> and <code class="docutils literal notranslate"><span class="pre">:special-members:</span></code> are given.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6830">#6830</a>: py domain: <code class="docutils literal notranslate"><span class="pre">meta</span></code> fields in info-field-list becomes reserved. They
are not displayed on output document now</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6417">#6417</a>: py domain: doctree of desc_parameterlist has been changed. The
argument names, annotations and default values are wrapped with inline node</p></li>
<li><p>The structure of <code class="docutils literal notranslate"><span class="pre">sphinx.events.EventManager.listeners</span></code> has changed</p></li>
<li><p>Due to the scoping changes for <a class="reference internal" href="usage/restructuredtext/directives.html#directive-productionlist" title="productionlist directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">productionlist</span></code></a> some uses of
<a class="reference internal" href="usage/restructuredtext/roles.html#role-token" title="token role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">token</span></code></a> must be modified to include the scope which was previously
ignored.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6903">#6903</a>: Internal data structure of Python, reST and standard domains have
changed. The node_id is added to the index of objects and modules. Now they
contains a pair of docname and node_id for cross reference.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7276">#7276</a>: C++ domain: Non intended behavior is removed such as <code class="docutils literal notranslate"><span class="pre">say_hello_</span></code>
links to <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">cpp:function::</span> <span class="pre">say_hello()</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7210">#7210</a>: js domain: Non intended behavior is removed such as <code class="docutils literal notranslate"><span class="pre">parseInt_</span></code> links
to <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">js:function::</span> <span class="pre">parseInt</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7229">#7229</a>: rst domain: Non intended behavior is removed such as <code class="docutils literal notranslate"><span class="pre">numref_</span></code> links
to <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">rst:role::</span> <span class="pre">numref</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6903">#6903</a>: py domain: Non intended behavior is removed such as <code class="docutils literal notranslate"><span class="pre">say_hello_</span></code>
links to <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">py:function::</span> <span class="pre">say_hello()</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7246">#7246</a>: py domain: Drop special cross reference helper for exceptions,
functions and methods</p></li>
<li><p>The C domain has been rewritten, with additional directives and roles.
The existing ones are now more strict, resulting in new warnings.</p></li>
<li><p>The attribute <code class="docutils literal notranslate"><span class="pre">sphinx_cpp_tagname</span></code> in the <code class="docutils literal notranslate"><span class="pre">desc_signature_line</span></code> node
has been renamed to <code class="docutils literal notranslate"><span class="pre">sphinx_line_type</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6462">#6462</a>: double backslashes in domain directives are no longer replaced by
single backslashes as default. A new configuration value
<a class="reference internal" href="usage/configuration.html#confval-strip_signature_backslash"><code class="xref std std-confval docutils literal notranslate"><span class="pre">strip_signature_backslash</span></code></a> can be used by users to re-enable it.</p></li>
</ul>
<p>3.0.0 final</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7222">#7222</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.util.inspect.unwrap()</span></code> is renamed to <code class="docutils literal notranslate"><span class="pre">unwrap_all()</span></code></p></li>
</ul>
</section>
<section id="id1072">
<h3>Deprecated<a class="headerlink" href="#id1072" title="Link to this heading">¶</a></h3>
<p>3.0.0b1</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">desc_signature['first']</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.DescDirective</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.std.StandardDomain.add_object()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.python.PyDecoratorMixin</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.get_documenters()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.process_autosummary_toc()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.parsers.Parser.app</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.testing.path.Path.text()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.testing.path.Path.bytes()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.inspect.getargspec()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXWriter.format_docclass()</span></code></p></li>
</ul>
</section>
<section id="id1073">
<h3>Features added<a class="headerlink" href="#id1073" title="Link to this heading">¶</a></h3>
<p>3.0.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/247">#247</a>: autosummary: Add <a class="reference internal" href="usage/extensions/autosummary.html#confval-autosummary_generate_overwrite"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosummary_generate_overwrite</span></code></a> to overwrite
old stub file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5923">#5923</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">:inherited-members:</span></code> option takes a name of anchestor class
not to document inherited members of the class and uppers</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6830">#6830</a>: autodoc: consider a member private if docstring contains
<code class="docutils literal notranslate"><span class="pre">:meta</span> <span class="pre">private:</span></code> in info-field-list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7165">#7165</a>: autodoc: Support Annotated type (PEP-593)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2815">#2815</a>: autodoc: Support singledispatch functions and methods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7079">#7079</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints</span></code></a> accepts <code class="docutils literal notranslate"><span class="pre">"description"</span></code>
configuration. It shows typehints as object description</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7314">#7314</a>: apidoc: Propagate <code class="docutils literal notranslate"><span class="pre">--maxdepth</span></code> option through package documents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6558">#6558</a>: glossary: emit a warning for duplicated glossary entry</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3106">#3106</a>: domain: Register hyperlink target for index page automatically</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6558">#6558</a>: std domain: emit a warning for duplicated generic objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6830">#6830</a>: py domain: Add new event: <a class="reference internal" href="extdev/appapi.html#event-object-description-transform"><code class="xref std std-event docutils literal notranslate"><span class="pre">object-description-transform</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6895">#6895</a>: py domain: Do not emit nitpicky warnings for built-in types</p></li>
<li><p>py domain: Support lambda functions in function signature</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6417">#6417</a>: py domain: Allow to make a style for arguments of functions and methods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7238">#7238</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7239">#7239</a>: py domain: Emit a warning on describing a python object if the
entry is already added as the same name</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7341">#7341</a>: py domain: type annotations in signature are converted to cross refs</p></li>
<li><p>Support priority of event handlers. For more detail, see
<a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.connect" title="sphinx.application.Sphinx.connect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Sphinx.connect()</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3077">#3077</a>: Implement the scoping for <a class="reference internal" href="usage/restructuredtext/directives.html#directive-productionlist" title="productionlist directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">productionlist</span></code></a> as indicated
in the documentation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1027">#1027</a>: Support backslash line continuation in <a class="reference internal" href="usage/restructuredtext/directives.html#directive-productionlist" title="productionlist directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">productionlist</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7108">#7108</a>: config: Allow to show an error message from conf.py via <code class="docutils literal notranslate"><span class="pre">ConfigError</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7032">#7032</a>: html: <a class="reference internal" href="usage/configuration.html#confval-html_scaled_image_link"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_scaled_image_link</span></code></a> will be disabled for images having
<code class="docutils literal notranslate"><span class="pre">no-scaled-link</span></code> class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7144">#7144</a>: Add CSS class indicating its domain for each desc node</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7211">#7211</a>: latex: Use babel for Chinese document when using XeLaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6672">#6672</a>: LaTeX: Support LaTeX Theming (experimental)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7005">#7005</a>: LaTeX: Add LaTeX styling macro for <a class="reference internal" href="usage/restructuredtext/roles.html#role-kbd" title="kbd role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">kbd</span></code></a> role</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7220">#7220</a>: genindex: Show “main” index entries at first</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7103">#7103</a>: linkcheck: writes all links to <code class="docutils literal notranslate"><span class="pre">output.json</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7025">#7025</a>: html search: full text search can be disabled for individual document
using <code class="docutils literal notranslate"><span class="pre">:nosearch:</span></code> file-wide metadata</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7293">#7293</a>: html search: Allow to override JavaScript splitter via
<code class="docutils literal notranslate"><span class="pre">SearchLanguage.js_splitter_code</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7142">#7142</a>: html theme: Add a theme option: <code class="docutils literal notranslate"><span class="pre">pygments_dark_style</span></code> to switch the
style of code-blocks in dark mode</p></li>
<li><p>The C domain has been rewritten adding for example:</p>
<ul>
<li><p>Cross-referencing respecting the current scope.</p></li>
<li><p>Possible to document anonymous entities.</p></li>
<li><p>More specific directives and roles for each type of entity,
e.g., handling scoping of enumerators.</p></li>
<li><p>New role <a class="reference internal" href="usage/restructuredtext/domains.html#role-c-expr" title="c:expr role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">c:expr</span></code></a> for rendering expressions and types
in text.</p></li>
</ul>
</li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">SphinxDirective.get_source_info()</span></code>
and <code class="docutils literal notranslate"><span class="pre">SphinxRole.get_source_info()</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7324">#7324</a>: sphinx-build: Emit a warning if multiple files having different file
extensions for same document found</p></li>
</ul>
<p>3.0.0 final</p>
<ul class="simple">
<li><p>Added <code class="docutils literal notranslate"><span class="pre">ObjectDescription.transform_content()</span></code>.</p></li>
</ul>
</section>
<section id="id1104">
<h3>Bugs fixed<a class="headerlink" href="#id1104" title="Link to this heading">¶</a></h3>
<p>3.0.0b1</p>
<ul class="simple">
<li><p>C++, fix cross reference lookup in certain cases involving
function overloads.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5078">#5078</a>: C++, fix cross reference lookup when a directive contains multiple
declarations.</p></li>
<li><p>C++, suppress warnings for directly dependent typenames in cross references
generated automatically in signatures.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5637">#5637</a>: autodoc: Incorrect handling of nested class names on show-inheritance</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7267">#7267</a>: autodoc: error message for invalid directive options has wrong location</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7329">#7329</a>: autodoc: info-field-list is wrongly generated from type hints into the
class description even if <code class="docutils literal notranslate"><span class="pre">autoclass_content='class'</span></code> set</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7331">#7331</a>: autodoc: a cython-function is not recognized as a function</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5637">#5637</a>: inheritance_diagram: Incorrect handling of nested class names</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7139">#7139</a>: <code class="docutils literal notranslate"><span class="pre">code-block::</span> <span class="pre">guess</span></code> does not work</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7325">#7325</a>: html: source_suffix containing dot leads to wrong source link</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7357">#7357</a>: html: Resizing SVG image fails with ValueError</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7278">#7278</a>: html search: Fix use of <code class="docutils literal notranslate"><span class="pre">html_file_suffix</span></code> instead of
<code class="docutils literal notranslate"><span class="pre">html_link_suffix</span></code> in search results</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7297">#7297</a>: html theme: <code class="docutils literal notranslate"><span class="pre">bizstyle</span></code> does not support <code class="docutils literal notranslate"><span class="pre">sidebarwidth</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3842">#3842</a>: singlehtml: Path to images broken when master doc is not in source root</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7179">#7179</a>: std domain: Fix whitespaces are suppressed on referring GenericObject</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7289">#7289</a>: console: use bright colors instead of bold</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1539">#1539</a>: C, parse array types.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2377">#2377</a>: C, parse function pointers even in complex types.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7345">#7345</a>: sphinx-build: Sphinx crashes if output directory exists as a file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7290">#7290</a>: sphinx-build: Ignore bdb.BdbQuit when handling exceptions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6240">#6240</a>: napoleon: Attributes and Methods sections ignore :noindex: option</p></li>
</ul>
<p>3.0.0 final</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7364">#7364</a>: autosummary: crashed when <a class="reference internal" href="usage/extensions/autosummary.html#confval-autosummary_generate"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosummary_generate</span></code></a> is False</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7370">#7370</a>: autosummary: raises UnboundLocalError when unknown module given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7367">#7367</a>: C++, alternate operator spellings are now supported.</p></li>
<li><p>C, alternate operator spellings are now supported.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7368">#7368</a>: C++, comma operator in expressions, pack expansion in template
argument lists, and more comprehensive error messages in some cases.</p></li>
<li><p>C, C++, fix crash and wrong duplicate warnings related to anon symbols.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6477">#6477</a>: Escape first “!” in a cross reference linking no longer possible</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7219">#7219</a>: py domain: The index entry generated by <code class="docutils literal notranslate"><span class="pre">py:function</span></code> directive is
different with one from <code class="docutils literal notranslate"><span class="pre">index</span></code> directive with “builtin” type</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7301">#7301</a>: capital characters are not allowed for node_id</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7301">#7301</a>: epub: duplicated node_ids are generated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6564">#6564</a>: html: a width of table was ignored on HTML builder</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7401">#7401</a>: Incorrect argument is passed for <a class="reference internal" href="extdev/appapi.html#event-env-get-outdated"><code class="xref std std-event docutils literal notranslate"><span class="pre">env-get-outdated</span></code></a> handlers</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7355">#7355</a>: autodoc: a signature of cython-function is not recognized well</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7222">#7222</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">__wrapped__</span></code> functions are not documented correctly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7409">#7409</a>: intersphinx: ValueError is raised when an extension sets up
<a class="reference internal" href="usage/extensions/intersphinx.html#confval-intersphinx_mapping"><code class="xref std std-confval docutils literal notranslate"><span class="pre">intersphinx_mapping</span></code></a> on <a class="reference internal" href="extdev/appapi.html#event-config-inited"><code class="xref std std-event docutils literal notranslate"><span class="pre">config-inited</span></code></a> event</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7343">#7343</a>: Sphinx builds has been slower since 2.4.0 on debug mode</p></li>
</ul>
</section>
</section>
<section id="release-2-4-5-released-nov-18-2021">
<h2>Release 2.4.5 (released Nov 18, 2021)<a class="headerlink" href="#release-2-4-5-released-nov-18-2021" title="Link to this heading">¶</a></h2>
<section id="id1138">
<h3>Dependencies<a class="headerlink" href="#id1138" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9807">#9807</a>: Restrict docutils to 0.17.x or older</p></li>
</ul>
</section>
</section>
<section id="release-2-4-4-released-mar-05-2020">
<h2>Release 2.4.4 (released Mar 05, 2020)<a class="headerlink" href="#release-2-4-4-released-mar-05-2020" title="Link to this heading">¶</a></h2>
<section id="id1140">
<h3>Bugs fixed<a class="headerlink" href="#id1140" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7197">#7197</a>: LaTeX: platex cause error to build image directive with target url</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7223">#7223</a>: Sphinx builds has been slower since 2.4.0</p></li>
</ul>
</section>
</section>
<section id="release-2-4-3-released-feb-22-2020">
<h2>Release 2.4.3 (released Feb 22, 2020)<a class="headerlink" href="#release-2-4-3-released-feb-22-2020" title="Link to this heading">¶</a></h2>
<section id="id1143">
<h3>Bugs fixed<a class="headerlink" href="#id1143" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7184">#7184</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">*args</span></code> and <code class="docutils literal notranslate"><span class="pre">**kwarg</span></code> in type comments are not handled
properly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7189">#7189</a>: autodoc: classmethod coroutines are not detected</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7183">#7183</a>: intersphinx: <code class="docutils literal notranslate"><span class="pre">:attr:</span></code> reference to property is broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6244">#6244</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6387">#6387</a>: html search: Search breaks/hangs when built with dirhtml builder</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7195">#7195</a>: todo: emit doctree-resolved event with non-document node incorrectly</p></li>
</ul>
</section>
</section>
<section id="release-2-4-2-released-feb-19-2020">
<h2>Release 2.4.2 (released Feb 19, 2020)<a class="headerlink" href="#release-2-4-2-released-feb-19-2020" title="Link to this heading">¶</a></h2>
<section id="id1150">
<h3>Bugs fixed<a class="headerlink" href="#id1150" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7138">#7138</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">autodoc.typehints</span></code> crashed when variable has unbound object
as a value</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7156">#7156</a>: autodoc: separator for keyword only arguments is not shown</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7146">#7146</a>: autodoc: IndexError is raised on suppressed type_comment found</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7161">#7161</a>: autodoc: typehints extension does not support parallel build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7178">#7178</a>: autodoc: TypeError is raised on fetching type annotations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7151">#7151</a>: crashed when extension assigns a value to <code class="docutils literal notranslate"><span class="pre">env.indexentries</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7170">#7170</a>: text: Remove debug print</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7137">#7137</a>: viewcode: Avoid to crash when non-python code given</p></li>
</ul>
</section>
</section>
<section id="release-2-4-1-released-feb-11-2020">
<h2>Release 2.4.1 (released Feb 11, 2020)<a class="headerlink" href="#release-2-4-1-released-feb-11-2020" title="Link to this heading">¶</a></h2>
<section id="id1159">
<h3>Bugs fixed<a class="headerlink" href="#id1159" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7120">#7120</a>: html: crashed when on scaling SVG images which have float dimensions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7126">#7126</a>: autodoc: TypeError: ‘getset_descriptor’ object is not iterable</p></li>
</ul>
</section>
</section>
<section id="release-2-4-0-released-feb-09-2020">
<h2>Release 2.4.0 (released Feb 09, 2020)<a class="headerlink" href="#release-2-4-0-released-feb-09-2020" title="Link to this heading">¶</a></h2>
<section id="id1162">
<h3>Deprecated<a class="headerlink" href="#id1162" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>The <code class="docutils literal notranslate"><span class="pre">decode</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.pycode.ModuleAnalyzer()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.other.Index</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.environment.temp_data['gloss_entries']</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.environment.BuildEnvironment.indexentries</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.environment.collectors.indexentries.IndexEntriesCollector</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.apidoc.INITPY</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.apidoc.shall_skip()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.FiletypeNotFoundError</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.get_filetype()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.pycode.ModuleAnalyzer.encoding</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.roles.Index</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.detect_encoding()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.get_module_source()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.inspect.Signature</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.inspect.safe_getmembers()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.settings.author</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.settings.contentsname</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.settings.docclass</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.settings.docname</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.settings.title</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.ADDITIONAL_SETTINGS</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.DEFAULT_SETTINGS</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG</span></code></p></li>
</ul>
</section>
<section id="id1163">
<h3>Features added<a class="headerlink" href="#id1163" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6910">#6910</a>: inheritance_diagram: Make the background of diagrams transparent</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6446">#6446</a>: duration: Add <code class="docutils literal notranslate"><span class="pre">sphinx.ext.durations</span></code> to inspect which documents slow
down the build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6837">#6837</a>: LaTeX: Support a nested table</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7115">#7115</a>: LaTeX: Allow to override LATEXOPTS and LATEXMKOPTS via environment
variable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6966">#6966</a>: graphviz: Support <code class="docutils literal notranslate"><span class="pre">:class:</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6696">#6696</a>: html: <code class="docutils literal notranslate"><span class="pre">:scale:</span></code> option of image/figure directive not working for SVG
images (imagesize-1.2.0 or above is required)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6994">#6994</a>: imgconverter: Support illustrator file (.ai) to .png conversion</p></li>
<li><p>autodoc: Support Positional-Only Argument separator (PEP-570 compliant)</p></li>
<li><p>autodoc: Support type annotations for variables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2755">#2755</a>: autodoc: Add new event: <a class="reference internal" href="usage/extensions/autodoc.html#event-autodoc-before-process-signature"><code class="xref std std-event docutils literal notranslate"><span class="pre">autodoc-before-process-signature</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2755">#2755</a>: autodoc: Support type_comment style (ex. <code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">type:</span> <span class="pre">(str)</span> <span class="pre">-></span> <span class="pre">str</span></code>)
annotation (python3.8+ or <a class="reference external" href="https://github.com/python/typed_ast">typed_ast</a>
is required)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7051">#7051</a>: autodoc: Support instance variables without defaults (PEP-526)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6418">#6418</a>: autodoc: Add a new extension <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.typehints</span></code>. It shows
typehints as object description if <code class="docutils literal notranslate"><span class="pre">autodoc_typehints</span> <span class="pre">=</span> <span class="pre">"description"</span></code> set.
This is an experimental extension and it will be integrated into autodoc core
in Sphinx 3.0</p></li>
<li><p>SphinxTranslator now calls visitor/departure method for super node class if
visitor/departure method for original node class not found</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6418">#6418</a>: Add new event: <a class="reference internal" href="extdev/appapi.html#event-object-description-transform"><code class="xref std std-event docutils literal notranslate"><span class="pre">object-description-transform</span></code></a></p></li>
<li><p>py domain: <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-data" title="py:data directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:data</span></code></a> and <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-attribute" title="py:attribute directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:attribute</span></code></a> take new options
named <code class="docutils literal notranslate"><span class="pre">:type:</span></code> and <code class="docutils literal notranslate"><span class="pre">:value:</span></code> to describe its type and initial value</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6785">#6785</a>: py domain: <code class="docutils literal notranslate"><span class="pre">:py:attr:</span></code> is able to refer properties again</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6772">#6772</a>: apidoc: Add <code class="docutils literal notranslate"><span class="pre">-q</span></code> option for quiet mode</p></li>
</ul>
</section>
<section id="id1178">
<h3>Bugs fixed<a class="headerlink" href="#id1178" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6925">#6925</a>: html: Remove redundant type=”text/javascript” from <script> elements</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7112">#7112</a>: html: SVG image is not layouted as float even if aligned</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6906">#6906</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6907">#6907</a>: autodoc: failed to read the source codes encoeded in cp1251</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6961">#6961</a>: latex: warning for babel shown twice</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7059">#7059</a>: latex: LaTeX compilation falls into infinite loop (wrapfig issue)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6581">#6581</a>: latex: <code class="docutils literal notranslate"><span class="pre">:reversed:</span></code> option for toctree does not effect to LaTeX build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6559">#6559</a>: Wrong node-ids are generated in glossary directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6986">#6986</a>: apidoc: misdetects module name for .so file inside module</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6899">#6899</a>: apidoc: private members are not shown even if <code class="docutils literal notranslate"><span class="pre">--private</span></code> given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6327">#6327</a>: apidoc: Support a python package consisted of __init__.so file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6999">#6999</a>: napoleon: fails to parse tilde in :exc: role</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7019">#7019</a>: gettext: Absolute path used in message catalogs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7023">#7023</a>: autodoc: nested partial functions are not listed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7023">#7023</a>: autodoc: partial functions imported from other modules are listed as
module members without :impoprted-members: option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6889">#6889</a>: autodoc: Trailing comma in <code class="docutils literal notranslate"><span class="pre">:members::</span></code> option causes cryptic warning</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6568">#6568</a>: autosummary: <code class="docutils literal notranslate"><span class="pre">autosummary_imported_members</span></code> is ignored on generating
a stub file for submodule</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7055">#7055</a>: linkcheck: redirect is treated as an error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7088">#7088</a>: HTML template: If <code class="docutils literal notranslate"><span class="pre">navigation_with_keys</span></code> option is activated,
modifier keys are ignored, which means the feature can interfere with browser
features</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7090">#7090</a>: std domain: Can’t assign numfig-numbers for custom container nodes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7106">#7106</a>: std domain: enumerated nodes are marked as duplicated when extensions
call <code class="docutils literal notranslate"><span class="pre">note_explicit_target()</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7095">#7095</a>: dirhtml: Cross references are broken via intersphinx and <code class="docutils literal notranslate"><span class="pre">:doc:</span></code> role</p></li>
<li><p>C++:</p>
<ul>
<li><p>Don’t crash when using the <code class="docutils literal notranslate"><span class="pre">struct</span></code> role in some cases.</p></li>
<li><p>Don’t warn when using the <code class="docutils literal notranslate"><span class="pre">var</span></code>/<code class="docutils literal notranslate"><span class="pre">member</span></code> role for function
parameters.</p></li>
<li><p>Render call and braced-init expressions correctly.</p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/7097">#7097</a>: Filenames of images generated by
<code class="docutils literal notranslate"><span class="pre">sphinx.transforms.post_transforms.images.ImageConverter</span></code>
or its subclasses (used for latex build) are now sanitized,
to prevent broken paths</p></li>
</ul>
</section>
</section>
<section id="release-2-3-1-released-dec-22-2019">
<h2>Release 2.3.1 (released Dec 22, 2019)<a class="headerlink" href="#release-2-3-1-released-dec-22-2019" title="Link to this heading">¶</a></h2>
<section id="id1202">
<h3>Bugs fixed<a class="headerlink" href="#id1202" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6936">#6936</a>: sphinx-autogen: raises AttributeError</p></li>
</ul>
</section>
</section>
<section id="release-2-3-0-released-dec-15-2019">
<h2>Release 2.3.0 (released Dec 15, 2019)<a class="headerlink" href="#release-2-3-0-released-dec-15-2019" title="Link to this heading">¶</a></h2>
<section id="id1204">
<h3>Incompatible changes<a class="headerlink" href="#id1204" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6742">#6742</a>: <code class="docutils literal notranslate"><span class="pre">end-before</span></code> option of <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> directive does not
match the first line of the code block.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1331">#1331</a>: Change default User-Agent header to <code class="docutils literal notranslate"><span class="pre">"Sphinx/X.Y.Z</span> <span class="pre">requests/X.Y.Z</span>
<span class="pre">python/X.Y.Z"</span></code>. It can be changed via <a class="reference internal" href="usage/configuration.html#confval-user_agent"><code class="xref std std-confval docutils literal notranslate"><span class="pre">user_agent</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6867">#6867</a>: text: content of admonitions starts after a blank line</p></li>
</ul>
</section>
<section id="id1208">
<h3>Deprecated<a class="headerlink" href="#id1208" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.gettext.POHEADER</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.SphinxStandaloneReader.app</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.SphinxStandaloneReader.env</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.texescape.tex_escape_map</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.texescape.tex_hl_escape_map_new</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.no_contractions</span></code></p></li>
</ul>
</section>
<section id="id1209">
<h3>Features added<a class="headerlink" href="#id1209" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6707">#6707</a>: C++, support bit-fields.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/267">#267</a>: html: Eliminate prompt characters of doctest block from copyable text</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6548">#6548</a>: html: Use favicon for OpenSearch if available</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6729">#6729</a>: html theme: agogo theme now supports <code class="docutils literal notranslate"><span class="pre">rightsidebar</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6780">#6780</a>: Add PEP-561 Support</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6762">#6762</a>: latex: Allow to load additional LaTeX packages via <code class="docutils literal notranslate"><span class="pre">extrapackages</span></code> key
of <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1331">#1331</a>: Add new config variable: <a class="reference internal" href="usage/configuration.html#confval-user_agent"><code class="xref std std-confval docutils literal notranslate"><span class="pre">user_agent</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6000">#6000</a>: LaTeX: have backslash also be an inline literal word wrap break
character</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4186">#4186</a>: LaTeX: Support upLaTeX as a new <a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a> (experimental)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6812">#6812</a>: Improve a warning message when extensions are not parallel safe</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6818">#6818</a>: Improve Intersphinx performance for multiple remote inventories.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2546">#2546</a>: apidoc: .so file support</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6798">#6798</a>: autosummary: emit <code class="docutils literal notranslate"><span class="pre">autodoc-skip-member</span></code> event on generating stub file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6483">#6483</a>: i18n: make explicit titles in toctree translatable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6816">#6816</a>: linkcheck: Add <a class="reference internal" href="usage/configuration.html#confval-linkcheck_auth"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_auth</span></code></a> option to provide
authentication information when doing <code class="docutils literal notranslate"><span class="pre">linkcheck</span></code> builds</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6872">#6872</a>: linkcheck: Handles HTTP 308 Permanent Redirect</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6613">#6613</a>: html: Wrap section number in span tag</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6781">#6781</a>: gettext: Add <code class="xref std std-confval docutils literal notranslate"><span class="pre">gettext_last_translator</span></code> and
<code class="xref std std-confval docutils literal notranslate"><span class="pre">gettext_language_team</span></code> to customize headers of POT file</p></li>
</ul>
</section>
<section id="id1228">
<h3>Bugs fixed<a class="headerlink" href="#id1228" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6668">#6668</a>: LaTeX: Longtable before header has incorrect distance
(refs: <a class="reference external" href="https://github.com/latex3/latex2e/issues/173">latex3/latex2e`#173 <https://github.com/sphinx-doc/sphinx/issues/173>`_</a>)</p>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6618">#6618</a>: LaTeX: Avoid section names at the end of a page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6738">#6738</a>: LaTeX: Do not replace unicode characters by LaTeX macros on unicode
supported LaTeX engines: ¶, §, €, ∞, ±, →, ‣, –, superscript and subscript
digits go through “as is” (as default OpenType font supports them)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6704">#6704</a>: linkcheck: Be defensive and handle newly defined HTTP error code</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6806">#6806</a>: linkcheck: Failure on parsing content</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6655">#6655</a>: image URLs containing <code class="docutils literal notranslate"><span class="pre">data:</span></code> causes gettext builder crashed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6584">#6584</a>: i18n: Error when compiling message catalogs on Hindi</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6718">#6718</a>: i18n: KeyError is raised if section title and table title are same</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6743">#6743</a>: i18n: <a class="reference internal" href="usage/configuration.html#confval-rst_prolog"><code class="xref std std-confval docutils literal notranslate"><span class="pre">rst_prolog</span></code></a> breaks the translation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6708">#6708</a>: mathbase: Some deprecated functions have removed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6709">#6709</a>: autodoc: mock object does not work as a class decorator</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5070">#5070</a>: epub: Wrong internal href fragment links</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6712">#6712</a>: Allow not to install sphinx.testing as runtime (mainly for ALT Linux)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6741">#6741</a>: html: search result was broken with empty <a class="reference internal" href="usage/configuration.html#confval-html_file_suffix"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_file_suffix</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6001">#6001</a>: LaTeX does not wrap long code lines at backslash character</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6804">#6804</a>: LaTeX: PDF build breaks if admonition of danger type contains
code-block long enough not to fit on one page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6809">#6809</a>: LaTeX: code-block in a danger type admonition can easily spill over
bottom of page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6793">#6793</a>: texinfo: Code examples broken following “sidebar”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6813">#6813</a>: An orphan warning is emitted for included document on Windows. Thanks
to @drillan</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6850">#6850</a>: Fix smartypants module calls re.sub() with wrong options</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6824">#6824</a>: HTML search: If a search term is partially matched in the title and
fully matched in a text paragraph on the same page, the search does not
include this match.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6848">#6848</a>: config.py shouldn’t pop extensions from overrides</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6867">#6867</a>: text: extra spaces are inserted to hyphenated words on folding lines</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6886">#6886</a>: LaTeX: xelatex converts straight double quotes into right curly ones
(shows when <a class="reference internal" href="usage/configuration.html#confval-smartquotes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">smartquotes</span></code></a> is <code class="docutils literal notranslate"><span class="pre">False</span></code>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6890">#6890</a>: LaTeX: even with smartquotes off, PDF output transforms straight
quotes and consecutive hyphens into curly quotes and dashes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6876">#6876</a>: LaTeX: multi-line display of authors on title page has ragged edges</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6887">#6887</a>: Sphinx crashes with docutils-0.16b0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6920">#6920</a>: sphinx-build: A console message is wrongly highlighted</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6900">#6900</a>: sphinx-build: <code class="docutils literal notranslate"><span class="pre">-D</span></code> option does not considers <code class="docutils literal notranslate"><span class="pre">0</span></code> and <code class="docutils literal notranslate"><span class="pre">1</span></code> as a
boolean value</p></li>
</ul>
</section>
</section>
<section id="release-2-2-2-released-dec-03-2019">
<h2>Release 2.2.2 (released Dec 03, 2019)<a class="headerlink" href="#release-2-2-2-released-dec-03-2019" title="Link to this heading">¶</a></h2>
<section id="id1258">
<h3>Incompatible changes<a class="headerlink" href="#id1258" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6803">#6803</a>: For security reason of python, parallel mode is disabled on macOS and
Python3.8+</p></li>
</ul>
</section>
<section id="id1260">
<h3>Bugs fixed<a class="headerlink" href="#id1260" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6776">#6776</a>: LaTeX: 2019-10-01 LaTeX release breaks <code class="file docutils literal notranslate"><span class="pre">sphinxcyrillic.sty</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6815">#6815</a>: i18n: French, Hindi, Chinese, Japanese and Korean translation messages
has been broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6803">#6803</a>: parallel build causes AttributeError on macOS and Python3.8</p></li>
</ul>
</section>
</section>
<section id="release-2-2-1-released-oct-26-2019">
<h2>Release 2.2.1 (released Oct 26, 2019)<a class="headerlink" href="#release-2-2-1-released-oct-26-2019" title="Link to this heading">¶</a></h2>
<section id="id1264">
<h3>Bugs fixed<a class="headerlink" href="#id1264" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6641">#6641</a>: LaTeX: Undefined control sequence <code class="docutils literal notranslate"><span class="pre">\sphinxmaketitle</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6710">#6710</a>: LaTeX not well configured for Greek language as main language</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6759">#6759</a>: validation of html static paths and extra paths no longer throws
an error if the paths are in different directories</p></li>
</ul>
</section>
</section>
<section id="release-2-2-0-released-aug-19-2019">
<h2>Release 2.2.0 (released Aug 19, 2019)<a class="headerlink" href="#release-2-2-0-released-aug-19-2019" title="Link to this heading">¶</a></h2>
<section id="id1268">
<h3>Incompatible changes<a class="headerlink" href="#id1268" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>apidoc: template files are renamed to <code class="docutils literal notranslate"><span class="pre">.rst_t</span></code></p></li>
<li><p>html: Field lists will be styled by grid layout</p></li>
</ul>
</section>
<section id="id1269">
<h3>Deprecated<a class="headerlink" href="#id1269" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.math.MathDomain.add_equation()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.math.MathDomain.get_next_equation_number()</span></code></p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">info</span></code> and <code class="docutils literal notranslate"><span class="pre">warn</span></code> arguments of
<code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate.generate_autosummary_docs()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate._simple_info()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.generate._simple_warn()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.todo.merge_info()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.todo.process_todo_nodes()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.todo.process_todos()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.todo.purge_todos()</span></code></p></li>
</ul>
</section>
<section id="id1270">
<h3>Features added<a class="headerlink" href="#id1270" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5124">#5124</a>: graphviz: <code class="docutils literal notranslate"><span class="pre">:graphviz_dot:</span></code> option is renamed to <code class="docutils literal notranslate"><span class="pre">:layout:</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1464">#1464</a>: html: emit a warning if <a class="reference internal" href="usage/configuration.html#confval-html_static_path"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_static_path</span></code></a> and
<a class="reference internal" href="usage/configuration.html#confval-html_extra_path"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_extra_path</span></code></a> directories are inside output directory</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6514">#6514</a>: html: Add a label to search input for accessability purposes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5602">#5602</a>: apidoc: Add <code class="docutils literal notranslate"><span class="pre">--templatedir</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6475">#6475</a>: Add <code class="docutils literal notranslate"><span class="pre">override</span></code> argument to <code class="docutils literal notranslate"><span class="pre">app.add_autodocumenter()</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6310">#6310</a>: imgmath: let <a class="reference internal" href="usage/extensions/math.html#confval-imgmath_use_preview"><code class="xref std std-confval docutils literal notranslate"><span class="pre">imgmath_use_preview</span></code></a> work also with the SVG
format for images rendering inline math</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6533">#6533</a>: LaTeX: refactor visit_enumerated_list() to use <code class="docutils literal notranslate"><span class="pre">\sphinxsetlistlabels</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6628">#6628</a>: quickstart: Use <code class="docutils literal notranslate"><span class="pre">https://docs.python.org/3/</span></code> for default setting of
<a class="reference internal" href="usage/extensions/intersphinx.html#confval-intersphinx_mapping"><code class="xref std std-confval docutils literal notranslate"><span class="pre">intersphinx_mapping</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6419">#6419</a>: sphinx-build: give reasons why rebuilt</p></li>
</ul>
</section>
<section id="id1280">
<h3>Bugs fixed<a class="headerlink" href="#id1280" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>py domain: duplicated warning does not point the location of source code</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6499">#6499</a>: html: Sphinx never updates a copy of <a class="reference internal" href="usage/configuration.html#confval-html_logo"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_logo</span></code></a> even if
original file has changed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1125">#1125</a>: html theme: scrollbar is hard to see on classic theme and macOS</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5502">#5502</a>: linkcheck: Consider HTTP 503 response as not an error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6439">#6439</a>: Make generated download links reproducible</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6486">#6486</a>: UnboundLocalError is raised if broken extension installed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6567">#6567</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_inherit_docstrings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_inherit_docstrings</span></code></a> does not effect to
<code class="docutils literal notranslate"><span class="pre">__init__()</span></code> and <code class="docutils literal notranslate"><span class="pre">__new__()</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6574">#6574</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_member_order"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_member_order</span></code></a> does not refer order of
imports when <code class="docutils literal notranslate"><span class="pre">'bysource'</span></code> order</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6574">#6574</a>: autodoc: missing type annotation for variadic and keyword parameters</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6589">#6589</a>: autodoc: Formatting issues with autodoc_typehints=’none’</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6605">#6605</a>: autodoc: crashed when target code contains custom method-like objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6498">#6498</a>: autosummary: crashed with wrong autosummary_generate setting</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6507">#6507</a>: autosummary: crashes without no autosummary_generate setting</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6511">#6511</a>: LaTeX: autonumbered list can not be customized in LaTeX
since Sphinx 1.8.0 (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6533">#6533</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6531">#6531</a>: Failed to load last environment object when extension added</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/736">#736</a>: Invalid sort in pair index</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6527">#6527</a>: <a class="reference internal" href="development/templating.html#last_updated" title="last_updated"><code class="xref py py-data docutils literal notranslate"><span class="pre">last_updated</span></code></a> wrongly assumes timezone as UTC</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5592">#5592</a>: std domain: <a class="reference internal" href="usage/restructuredtext/domains.html#directive-option" title="option directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">option</span></code></a> directive registers an index entry for
each comma separated option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6549">#6549</a>: sphinx-build: Escaped characters in error messages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6545">#6545</a>: doctest comments not getting trimmed since Sphinx 1.8.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6561">#6561</a>: glossary: Wrong hyperlinks are generated for non alphanumeric terms</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6620">#6620</a>: i18n: classifiers of definition list are not translated with
docutils-0.15</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6474">#6474</a>: <code class="docutils literal notranslate"><span class="pre">DocFieldTransformer</span></code> raises AttributeError when given directive is
not a subclass of ObjectDescription</p></li>
</ul>
</section>
</section>
<section id="release-2-1-2-released-jun-19-2019">
<h2>Release 2.1.2 (released Jun 19, 2019)<a class="headerlink" href="#release-2-1-2-released-jun-19-2019" title="Link to this heading">¶</a></h2>
<section id="id1304">
<h3>Bugs fixed<a class="headerlink" href="#id1304" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6497">#6497</a>: custom lexers fails highlighting when syntax error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6478">#6478</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6488">#6488</a>: info field lists are incorrectly recognized</p></li>
</ul>
</section>
</section>
<section id="release-2-1-1-released-jun-10-2019">
<h2>Release 2.1.1 (released Jun 10, 2019)<a class="headerlink" href="#release-2-1-1-released-jun-10-2019" title="Link to this heading">¶</a></h2>
<section id="id1308">
<h3>Incompatible changes<a class="headerlink" href="#id1308" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6447">#6447</a>: autodoc: Stop to generate document for undocumented module variables</p></li>
</ul>
</section>
<section id="id1310">
<h3>Bugs fixed<a class="headerlink" href="#id1310" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6442">#6442</a>: LaTeX: admonitions of <a class="reference internal" href="usage/restructuredtext/directives.html#directive-note" title="note directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">note</span></code></a> type can get separated from
immediately preceding section title by pagebreak</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6448">#6448</a>: autodoc: crashed when autodocumenting classes with <code class="docutils literal notranslate"><span class="pre">__slots__</span> <span class="pre">=</span> <span class="pre">None</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6451">#6451</a>: autodoc: generates docs for “optional import”ed modules as variables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6452">#6452</a>: autosummary: crashed when generating document of properties</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6455">#6455</a>: napoleon: docstrings for properties are not processed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6436">#6436</a>: napoleon: “Unknown target name” error if variable name ends with
underscore</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6440">#6440</a>: apidoc: missing blank lines between modules</p></li>
</ul>
</section>
</section>
<section id="release-2-1-0-released-jun-02-2019">
<h2>Release 2.1.0 (released Jun 02, 2019)<a class="headerlink" href="#release-2-1-0-released-jun-02-2019" title="Link to this heading">¶</a></h2>
<section id="id1318">
<h3>Incompatible changes<a class="headerlink" href="#id1318" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Ignore filenames without file extension given to <code class="docutils literal notranslate"><span class="pre">Builder.build_specific()</span></code>
API directly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6230">#6230</a>: The anchor of term in glossary directive is changed if it is consisted
by non-ASCII characters</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4550">#4550</a>: html: Centering tables by default using CSS</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6239">#6239</a>: latex: xelatex and xeCJK are used for Chinese documents by default</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Sphinx.add_lexer()</span></code> now takes a Lexer class instead of instance. An
instance of lexers are still supported until Sphinx 3.x.</p></li>
</ul>
</section>
<section id="id1322">
<h3>Deprecated<a class="headerlink" href="#id1322" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.latex.LaTeXBuilder.apply_transforms()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders._epub_base.EpubBuilder.esc()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Acks</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Author</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Centered</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Class</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.CodeBlock</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Figure</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.HList</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Highlight</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Include</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Index</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.LiteralInclude</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Meta</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.Only</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.SeeAlso</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.TabularColumns</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.TocTree</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.VersionChange</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.python.PyClassmember</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.python.PyModulelevel</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.std.StandardDomain._resolve_citation_xref()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.std.StandardDomain.note_citations()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.std.StandardDomain.note_citation_refs()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.std.StandardDomain.note_labels()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.environment.NoUri</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.apidoc.format_directive()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.apidoc.format_heading()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.apidoc.makename()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.importer.MockFinder</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.importer.MockLoader</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.importer.mock()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.autolink_role()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.imgmath.DOC_BODY</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.imgmath.DOC_BODY_PREVIEW</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.imgmath.DOC_HEAD</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.transforms.CitationReferences</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.transforms.SmartQuotesSkipper</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.node.find_source_node()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.i18n.find_catalog()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.i18n.find_catalog_files()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.i18n.find_catalog_source_files()</span></code></p></li>
</ul>
<p>For more details, see <a class="reference internal" href="extdev/deprecated.html#dev-deprecated-apis"><span class="std std-ref">deprecation APIs list</span></a>.</p>
</section>
<section id="id1323">
<h3>Features added<a class="headerlink" href="#id1323" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Add a helper class <code class="docutils literal notranslate"><span class="pre">sphinx.transforms.post_transforms.SphinxPostTransform</span></code></p></li>
<li><p>Add helper methods</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">PythonDomain.note_module()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PythonDomain.note_object()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">SphinxDirective.set_source_info()</span></code></p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6180">#6180</a>: Support <code class="docutils literal notranslate"><span class="pre">--keep-going</span></code> with <code class="docutils literal notranslate"><span class="pre">BuildDoc</span></code> setup command</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">math</span></code> directive now supports <code class="docutils literal notranslate"><span class="pre">:class:</span></code> option</p></li>
<li><p>todo: <code class="docutils literal notranslate"><span class="pre">todo</span></code> directive now supports <code class="docutils literal notranslate"><span class="pre">:name:</span></code> option</p></li>
<li><p>Enable override via environment of <code class="docutils literal notranslate"><span class="pre">SPHINXOPTS</span></code> and <code class="docutils literal notranslate"><span class="pre">SPHINXBUILD</span></code> Makefile
variables (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6232">#6232</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6303">#6303</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6287">#6287</a>: autodoc: Unable to document bound instance methods exported as module
functions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6289">#6289</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_default_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_default_options</span></code></a> now supports
<code class="docutils literal notranslate"><span class="pre">imported-members</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4777">#4777</a>: autodoc: Support coroutine</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/744">#744</a>: autodoc: Support abstractmethod</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6325">#6325</a>: autodoc: Support attributes in __slots__. For dict-style __slots__,
autodoc considers values as a docstring of the attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6361">#6361</a>: autodoc: Add <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_typehints"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_typehints</span></code></a> to suppress typehints from
signature</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1063">#1063</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">automodule</span></code> directive now handles undocumented module level
variables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6212">#6212</a> autosummary: Add <a class="reference internal" href="usage/extensions/autosummary.html#confval-autosummary_imported_members"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosummary_imported_members</span></code></a> to display
imported members on autosummary</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6271">#6271</a>: <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code> is catastrophically broken if building into ‘.’</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6363">#6363</a>: Support <code class="docutils literal notranslate"><span class="pre">%O%</span></code> environment variable in make.bat</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4777">#4777</a>: py domain: Add <code class="docutils literal notranslate"><span class="pre">:async:</span></code> option to <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-function" title="py:function directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:function</span></code></a> directive</p></li>
<li><p>py domain: Add new options to <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-method" title="py:method directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">py:method</span></code></a> directive</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">:abstractmethod:</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">:async:</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">:classmethod:</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">:property:</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">:staticmethod:</span></code></p></li>
</ul>
</li>
<li><p>rst domain: Add <a class="reference internal" href="usage/restructuredtext/domains.html#directive-rst-directive-option" title="rst:directive:option directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">rst:directive:option</span></code></a> directive to describe the option
for directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6306">#6306</a>: html: Add a label to search form for accessability purposes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4390">#4390</a>: html: Consistent and semantic CSS for signatures</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6358">#6358</a>: The <code class="docutils literal notranslate"><span class="pre">rawsource</span></code> property of <code class="docutils literal notranslate"><span class="pre">production</span></code> nodes now contains the
full production rule</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6373">#6373</a>: autosectionlabel: Allow suppression of warnings</p></li>
<li><p>coverage: Support a new <code class="docutils literal notranslate"><span class="pre">coverage_ignore_pyobjects</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6239">#6239</a>: latex: Support to build Chinese documents</p></li>
</ul>
</section>
<section id="id1343">
<h3>Bugs fixed<a class="headerlink" href="#id1343" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6230">#6230</a>: Inappropriate node_id has been generated by glossary directive if term
is consisted by non-ASCII characters</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6213">#6213</a>: ifconfig: contents after headings are not shown</p></li>
<li><p>commented term in glossary directive is wrongly recognized</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6299">#6299</a>: rst domain: rst:directive directive generates waste space</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6379">#6379</a>: py domain: Module index (py-modindex.html) has duplicate titles</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6331">#6331</a>: man: invalid output when doctest follows rubric</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6351">#6351</a>: “Hyperlink target is not referenced” message is shown even if
referenced</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6165">#6165</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">tab_width</span></code> setting of docutils has been ignored</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6347">#6347</a>: autodoc: crashes with a plain Tuple on Python 3.6 and 3.5</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6311">#6311</a>: autosummary: autosummary table gets confused by complex type hints</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6350">#6350</a>: autosummary: confused by an argument having some kind of default value</p></li>
<li><p>Generated Makefiles lack a final EOL (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6232">#6232</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6375">#6375</a>: extlinks: Cannot escape angle brackets in link caption</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6378">#6378</a>: linkcheck: Send commonly used User-Agent</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6387">#6387</a>: html search: failed to search document with haiku and scrolls themes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6408">#6408</a>: html search: Fix the ranking of search results</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6406">#6406</a>: Wrong year is returned for <code class="docutils literal notranslate"><span class="pre">SOURCE_DATE_EPOCH</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6402">#6402</a>: image directive crashes by unknown image format</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6286">#6286</a>: C++, allow 8 and 9 in hexadecimal integer literals.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6305">#6305</a>: Fix the string in quickstart for ‘path’ argument of parser</p></li>
<li><p>LaTeX: Figures in admonitions produced errors (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6364">#6364</a>)</p></li>
</ul>
</section>
</section>
<section id="release-2-0-1-released-apr-08-2019">
<h2>Release 2.0.1 (released Apr 08, 2019)<a class="headerlink" href="#release-2-0-1-released-apr-08-2019" title="Link to this heading">¶</a></h2>
<section id="id1364">
<h3>Bugs fixed<a class="headerlink" href="#id1364" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>LaTeX: some system labels are not translated</p></li>
<li><p>RemovedInSphinx30Warning is marked as pending</p></li>
<li><p>deprecation warnings are not emitted</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.application.CONFIG_FILENAME</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.htmlhelp</span></code></p></li>
<li><p><code class="xref std std-confval docutils literal notranslate"><span class="pre">viewcode_import</span></code></p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6208">#6208</a>: C++, properly parse full xrefs that happen to have a short xref as
prefix</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6220">#6220</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6225">#6225</a>: napoleon: AttributeError is raised for raised section having
references</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6245">#6245</a>: circular import error on importing SerializingHTMLBuilder</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6243">#6243</a>: LaTeX: ‘releasename’ setting for latex_elements is ignored</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6244">#6244</a>: html: Search function is broken with 3rd party themes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6263">#6263</a>: html: HTML5Translator crashed with invalid field node</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6262">#6262</a>: html theme: The style of field lists has changed in bizstyle theme</p></li>
</ul>
</section>
</section>
<section id="release-2-0-0-released-mar-29-2019">
<h2>Release 2.0.0 (released Mar 29, 2019)<a class="headerlink" href="#release-2-0-0-released-mar-29-2019" title="Link to this heading">¶</a></h2>
<section id="id1373">
<h3>Dependencies<a class="headerlink" href="#id1373" title="Link to this heading">¶</a></h3>
<p>2.0.0b1</p>
<ul class="simple">
<li><p>LaTeX builder now depends on TeX Live 2015 or above.</p></li>
<li><p>LaTeX builder (with <code class="docutils literal notranslate"><span class="pre">'pdflatex'</span></code> <a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a>) will process
Unicode Greek letters in text (not in math mark-up) via the text font and
will not escape them to math mark-up. See the discussion of the
<code class="docutils literal notranslate"><span class="pre">'fontenc'</span></code> key of <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a>; such (optional) support for
Greek adds, for example on Ubuntu xenial, the <code class="docutils literal notranslate"><span class="pre">texlive-lang-greek</span></code> and (if
default font set-up is not modified) <code class="docutils literal notranslate"><span class="pre">cm-super(-minimal)</span></code> as additional
Sphinx LaTeX requirements.</p></li>
<li><p>LaTeX builder with <a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a> set to <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code> or to
<code class="docutils literal notranslate"><span class="pre">'lualatex'</span></code> requires (by default) the <code class="docutils literal notranslate"><span class="pre">FreeFont</span></code> fonts,
which in Ubuntu xenial are provided by package <code class="docutils literal notranslate"><span class="pre">fonts-freefont-otf</span></code>, and
e.g. in Fedora 29 via package <code class="docutils literal notranslate"><span class="pre">texlive-gnu-freefont</span></code>.</p></li>
<li><p>requests 2.5.0 or above</p></li>
<li><p>The six package is no longer a dependency</p></li>
<li><p>The sphinxcontrib-websupport package is no longer a dependency</p></li>
<li><p>Some packages are separated to sub packages:</p>
<ul>
<li><p>sphinxcontrib.applehelp</p></li>
<li><p>sphinxcontrib.devhelp</p></li>
<li><p>sphinxcontrib.htmlhelp</p></li>
<li><p>sphinxcontrib.jsmath</p></li>
<li><p>sphinxcontrib.serializinghtml</p></li>
<li><p>sphinxcontrib.qthelp</p></li>
</ul>
</li>
</ul>
</section>
<section id="id1374">
<h3>Incompatible changes<a class="headerlink" href="#id1374" title="Link to this heading">¶</a></h3>
<p>2.0.0b1</p>
<ul class="simple">
<li><p>Drop python 2.7 and 3.4 support</p></li>
<li><p>Drop docutils 0.11 support</p></li>
<li><p>Drop features and APIs deprecated in 1.7.x</p></li>
<li><p>The default setting for <a class="reference internal" href="usage/configuration.html#confval-master_doc"><code class="xref std std-confval docutils literal notranslate"><span class="pre">master_doc</span></code></a> is changed to <code class="docutils literal notranslate"><span class="pre">'index'</span></code> which
has been longly used as default of sphinx-quickstart.</p></li>
<li><p>LaTeX: Move message resources to <code class="docutils literal notranslate"><span class="pre">sphinxmessage.sty</span></code></p></li>
<li><p>LaTeX: Stop using <code class="docutils literal notranslate"><span class="pre">\captions<lang></span></code> macro for some labels</p></li>
<li><p>LaTeX: for <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code> and <code class="docutils literal notranslate"><span class="pre">'lualatex'</span></code>, use the <code class="docutils literal notranslate"><span class="pre">FreeFont</span></code> OpenType
fonts as default choice (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5645">#5645</a>)</p></li>
<li><p>LaTeX: <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code> and <code class="docutils literal notranslate"><span class="pre">'lualatex'</span></code> now use <code class="docutils literal notranslate"><span class="pre">\small</span></code> in code-blocks
(due to <code class="docutils literal notranslate"><span class="pre">FreeMono</span></code> character width) like <code class="docutils literal notranslate"><span class="pre">'pdflatex'</span></code> already did (due
to <code class="docutils literal notranslate"><span class="pre">Courier</span></code> character width). You may need to adjust this via
<a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a> <code class="docutils literal notranslate"><span class="pre">'fvset'</span></code> key, in case of usage of some other
OpenType fonts (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5768">#5768</a>)</p></li>
<li><p>LaTeX: Greek letters in text are not escaped to math mode mark-up, and they
will use the text font not the math font. The <code class="docutils literal notranslate"><span class="pre">LGR</span></code> font encoding must be
added to the <code class="docutils literal notranslate"><span class="pre">'fontenc'</span></code> key of <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a> for this to work
(only if it is needed by the document, of course).</p></li>
<li><p>LaTeX: setting the <a class="reference internal" href="usage/configuration.html#confval-language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">language</span></code></a> to <code class="docutils literal notranslate"><span class="pre">'en'</span></code> triggered <code class="docutils literal notranslate"><span class="pre">Sonny</span></code> option
of <code class="docutils literal notranslate"><span class="pre">fncychap</span></code>, now it is <code class="docutils literal notranslate"><span class="pre">Bjarne</span></code> to match case of no language specified.
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5772">#5772</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5770">#5770</a>: doctest: Follow <a class="reference internal" href="usage/configuration.html#confval-highlight_language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">highlight_language</span></code></a> on highlighting doctest
block. As a result, they are highlighted as python3 by default.</p></li>
<li><p>The order of argument for <code class="docutils literal notranslate"><span class="pre">HTMLTranslator</span></code>, <code class="docutils literal notranslate"><span class="pre">HTML5Translator</span></code> and
<code class="docutils literal notranslate"><span class="pre">ManualPageTranslator</span></code> are changed</p></li>
<li><p>LaTeX: hard-coded redefinitions of <code class="docutils literal notranslate"><span class="pre">\l@section</span></code> and <code class="docutils literal notranslate"><span class="pre">\l@subsection</span></code>
formerly done during loading of <code class="docutils literal notranslate"><span class="pre">'manual'</span></code> docclass get executed later, at
time of <code class="docutils literal notranslate"><span class="pre">\sphinxtableofcontents</span></code>. This means that custom user definitions
from LaTeX preamble now get overwritten. Use <code class="docutils literal notranslate"><span class="pre">\sphinxtableofcontentshook</span></code>
to insert custom user definitions. See <a class="reference internal" href="latex.html#latex-macros"><span class="std std-ref">Macros</span></a>.</p></li>
<li><p>quickstart: Simplify generated <code class="docutils literal notranslate"><span class="pre">conf.py</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4148">#4148</a>: quickstart: some questions are removed. They are still able to specify
via command line options</p></li>
<li><p>websupport: unbundled from sphinx core. Please use sphinxcontrib-websupport</p></li>
<li><p>C++, the visibility of base classes is now always rendered as present in the
input. That is, <code class="docutils literal notranslate"><span class="pre">private</span></code> is now shown, where it was ellided before.</p></li>
<li><p>LaTeX: graphics inclusion of oversized images rescales to not exceed
the text width and height, even if width and/or height option were used.
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5956">#5956</a>)</p></li>
<li><p>epub: <code class="docutils literal notranslate"><span class="pre">epub_title</span></code> defaults to the <a class="reference internal" href="usage/configuration.html#confval-project"><code class="xref std std-confval docutils literal notranslate"><span class="pre">project</span></code></a> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4550">#4550</a>: All tables and figures without <code class="docutils literal notranslate"><span class="pre">align</span></code> option are displayed to center</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4587">#4587</a>: html: Output HTML5 by default</p></li>
</ul>
<p>2.0.0b2</p>
<ul class="simple">
<li><p>texinfo: image files are copied into <code class="docutils literal notranslate"><span class="pre">name-figure</span></code> directory</p></li>
</ul>
</section>
<section id="id1383">
<h3>Deprecated<a class="headerlink" href="#id1383" title="Link to this heading">¶</a></h3>
<p>2.0.0b1</p>
<ul class="simple">
<li><p>Support for evaluating Python 2 syntax is deprecated. This includes
configuration files which should be converted to Python 3.</p></li>
<li><p>The arguments of <code class="docutils literal notranslate"><span class="pre">EpubBuilder.build_mimetype()</span></code>,
<code class="docutils literal notranslate"><span class="pre">EpubBuilder.build_container()</span></code>, <code class="docutils literal notranslate"><span class="pre">EpubBuilder.bulid_content()</span></code>,
<code class="docutils literal notranslate"><span class="pre">EpubBuilder.build_toc()</span></code> and <code class="docutils literal notranslate"><span class="pre">EpubBuilder.build_epub()</span></code></p></li>
<li><p>The arguments of <code class="docutils literal notranslate"><span class="pre">Epub3Builder.build_navigation_doc()</span></code></p></li>
<li><p>The config variables</p>
<ul>
<li><p><a class="reference internal" href="usage/configuration.html#confval-html_experimental_html5_writer"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_experimental_html5_writer</span></code></a></p></li>
</ul>
</li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">encoding</span></code> argument of <code class="docutils literal notranslate"><span class="pre">autodoc.Documenter.get_doc()</span></code>,
<code class="docutils literal notranslate"><span class="pre">autodoc.DocstringSignatureMixin.get_doc()</span></code>,
<code class="docutils literal notranslate"><span class="pre">autodoc.DocstringSignatureMixin._find_signature()</span></code>, and
<code class="docutils literal notranslate"><span class="pre">autodoc.ClassDocumenter.get_doc()</span></code> are deprecated.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">importer</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.importer._MockModule</span></code></p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">nodetype</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.search.WordCollector.</span>
<span class="pre">is_meta_keywords()</span></code></p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">suffix</span></code> argument of <code class="docutils literal notranslate"><span class="pre">env.doc2path()</span></code> is deprecated.</p></li>
<li><p>The string style <code class="docutils literal notranslate"><span class="pre">base</span></code> argument of <code class="docutils literal notranslate"><span class="pre">env.doc2path()</span></code> is deprecated.</p></li>
<li><p>The fallback to allow omitting the <code class="docutils literal notranslate"><span class="pre">filename</span></code> argument from an overridden
<code class="docutils literal notranslate"><span class="pre">IndexBuilder.feed()</span></code> method is deprecated.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.addnodes.abbreviation</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.application.Sphinx._setting_up_extension</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.epub3.Epub3Builder.validate_config_value()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.html.SingleFileHTMLBuilder</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builders.htmlhelp.HTMLHelpBuilder.open_file()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.cmd.quickstart.term_decode()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.cmd.quickstart.TERM_ENCODING</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.config.check_unicode()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.config.string_classes</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.cpp.DefinitionError.description</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.cpp.NoOldIdError.description</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.domains.cpp.UnsupportedMultiCharacterCharLiteral.decoded</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.importer._MockImporter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.Autosummary.warn()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.Autosummary.genopt</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.Autosummary.warnings</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.Autosummary.result</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.doctest.doctest_encode()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.SphinxBaseFileInput</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.SphinxFileInput.supported</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.SphinxRSTFileInput</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.registry.SphinxComponentRegistry.add_source_input()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.roles.abbr_role()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.roles.emph_literal_role()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.roles.menusel_role()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.roles.index_role()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.roles.indexmarkup_role()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.testing.util.remove_unicode_literal()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.attrdict</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.force_decode()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.get_matching_docs()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.inspect.Parameter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.jsonimpl</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.osutil.EEXIST</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.osutil.EINVAL</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.osutil.ENOENT</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.osutil.EPIPE</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.osutil.walk()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.PeekableIterator</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.NoneType</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.TextIOWrapper</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.UnicodeMixin</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.htmlescape</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.indent</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.sys_encoding</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.terminal_safe()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat.u</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.ExtBabel</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.babel_defmacro()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.collect_footnotes()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.text.TextTranslator._make_depart_admonition()</span></code></p></li>
<li><p>template variables for LaTeX template</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">logo</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numfig_format</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pageautorefname</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">translatablestrings</span></code></p></li>
</ul>
</li>
</ul>
<p>For more details, see <a class="reference internal" href="extdev/deprecated.html#dev-deprecated-apis"><span class="std std-ref">deprecation APIs list</span></a>.</p>
</section>
<section id="id1384">
<h3>Features added<a class="headerlink" href="#id1384" title="Link to this heading">¶</a></h3>
<p>2.0.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1618">#1618</a>: The search results preview of generated HTML documentation is
reader-friendlier: instead of showing the snippets as raw reStructuredText
markup, Sphinx now renders the corresponding HTML. This means the Sphinx
extension <a class="reference external" href="https://github.com/sphinx-contrib/sphinx-pretty-searchresults">Sphinx: pretty search results</a> is no longer necessary. Note that
changes to the search function of your custom or 3rd-party HTML template might
overwrite this improvement.</p>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4182">#4182</a>: autodoc: Support <a class="reference internal" href="usage/configuration.html#confval-suppress_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">suppress_warnings</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5533">#5533</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_default_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_default_options</span></code></a> supports <code class="docutils literal notranslate"><span class="pre">member-order</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5394">#5394</a>: autodoc: Display readable names in type annotations for mocked objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5459">#5459</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_default_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_default_options</span></code></a> accepts <code class="docutils literal notranslate"><span class="pre">True</span></code> as a value</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1148">#1148</a>: autodoc: Add <a class="reference internal" href="usage/extensions/autodoc.html#directive-autodecorator" title="autodecorator directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">autodecorator</span></code></a> directive for decorators</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5635">#5635</a>: autosummary: Add <a class="reference internal" href="usage/extensions/autosummary.html#confval-autosummary_mock_imports"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosummary_mock_imports</span></code></a> to mock external
libraries on importing targets</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4018">#4018</a>: htmlhelp: Add <a class="reference internal" href="usage/configuration.html#confval-htmlhelp_file_suffix"><code class="xref std std-confval docutils literal notranslate"><span class="pre">htmlhelp_file_suffix</span></code></a> and
<a class="reference internal" href="usage/configuration.html#confval-htmlhelp_link_suffix"><code class="xref std std-confval docutils literal notranslate"><span class="pre">htmlhelp_link_suffix</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5559">#5559</a>: text: Support complex tables (colspan and rowspan)</p></li>
<li><p>LaTeX: support rendering (not in math, yet) of Greek and Cyrillic Unicode
letters in non-Cyrillic document even with <code class="docutils literal notranslate"><span class="pre">'pdflatex'</span></code> as
<a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a> (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5645">#5645</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5660">#5660</a>: The <code class="docutils literal notranslate"><span class="pre">versionadded</span></code>, <code class="docutils literal notranslate"><span class="pre">versionchanged</span></code> and <code class="docutils literal notranslate"><span class="pre">deprecated</span></code> directives
are now generated with their own specific CSS classes
(<code class="docutils literal notranslate"><span class="pre">added</span></code>, <code class="docutils literal notranslate"><span class="pre">changed</span></code> and <code class="docutils literal notranslate"><span class="pre">deprecated</span></code>, respectively) in addition to the
generic <code class="docutils literal notranslate"><span class="pre">versionmodified</span></code> class.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5841">#5841</a>: apidoc: Add –extensions option to sphinx-apidoc</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4981">#4981</a>: C++, added an alias directive for inserting lists of declarations,
that references existing declarations (e.g., for making a synopsis).</p></li>
<li><p>C++: add <code class="docutils literal notranslate"><span class="pre">cpp:struct</span></code> to complement <code class="docutils literal notranslate"><span class="pre">cpp:class</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1341">#1341</a> the HTML search considers words that contain a search term of length
three or longer a match.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4611">#4611</a>: epub: Show warning for duplicated ToC entries</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1851">#1851</a>: Allow to omit an argument for <a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a> directive. If
omitted, it follows <a class="reference internal" href="usage/restructuredtext/directives.html#directive-highlight" title="highlight directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">highlight</span></code></a> or <a class="reference internal" href="usage/configuration.html#confval-highlight_language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">highlight_language</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4587">#4587</a>: html: Add <a class="reference internal" href="usage/configuration.html#confval-html4_writer"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html4_writer</span></code></a> to use old HTML4 writer</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6016">#6016</a>: HTML search: A placeholder for the search summary prevents search
result links from changing their position when the search terminates. This
makes navigating search results easier.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5196">#5196</a>: linkcheck also checks remote images exist</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5924">#5924</a>: githubpages: create CNAME file for custom domains when
<a class="reference internal" href="usage/configuration.html#confval-html_baseurl"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_baseurl</span></code></a> set</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4261">#4261</a>: autosectionlabel: restrict the labeled sections by new config value;
<a class="reference internal" href="usage/extensions/autosectionlabel.html#confval-autosectionlabel_maxdepth"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autosectionlabel_maxdepth</span></code></a></p></li>
</ul>
</section>
<section id="id1407">
<h3>Bugs fixed<a class="headerlink" href="#id1407" title="Link to this heading">¶</a></h3>
<p>2.0.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1682">#1682</a>: LaTeX: writer should not translate Greek unicode, but use textgreek
package</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5247">#5247</a>: LaTeX: PDF does not build with default font config for Russian
language and <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code> or <code class="docutils literal notranslate"><span class="pre">'lualatex'</span></code> as <a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a>
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5251">#5251</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5248">#5248</a>: LaTeX: Greek letters in section titles disappear from PDF bookmarks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5249">#5249</a>: LaTeX: Unicode Greek letters in math directive break PDF build
(fix requires extra set-up, see <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a> <code class="docutils literal notranslate"><span class="pre">'textgreek'</span></code> key
and/or <a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a> setting)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5772">#5772</a>: LaTeX: should the Bjarne style of fncychap be used for English also
if passed as language option?</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5179">#5179</a>: LaTeX: (lualatex only) escaping of <code class="docutils literal notranslate"><span class="pre">></span></code> by <code class="docutils literal notranslate"><span class="pre">\textgreater{}</span></code> is not
enough as <code class="docutils literal notranslate"><span class="pre">\textgreater{}\textgreater{}</span></code> applies TeX-ligature</p></li>
<li><p>LaTeX: project name is not escaped if <a class="reference internal" href="usage/configuration.html#confval-latex_documents"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_documents</span></code></a> omitted</p></li>
<li><p>LaTeX: authors are not shown if <a class="reference internal" href="usage/configuration.html#confval-latex_documents"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_documents</span></code></a> omitted</p></li>
<li><p>HTML: Invalid HTML5 file is generated for a glossary having multiple terms for
one description (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4611">#4611</a>)</p></li>
<li><p>QtHelp: OS dependent path separator is used in .qhp file</p></li>
<li><p>HTML search: search always returns nothing when multiple search terms are
used and one term is shorter than three characters</p></li>
</ul>
<p>2.0.0b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6096">#6096</a>: html: Anchor links are not added to figures</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3620">#3620</a>: html: Defer searchindex.js rather than loading it via ajax</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6113">#6113</a>: html: Table cells and list items have large margins</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5508">#5508</a>: <code class="docutils literal notranslate"><span class="pre">linenothreshold</span></code> option for <code class="docutils literal notranslate"><span class="pre">highlight</span></code> directive was ignored</p></li>
<li><p>texinfo: <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install-info</span></code> causes syntax error</p></li>
<li><p>texinfo: <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install-info</span></code> fails on macOS</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3079">#3079</a>: texinfo: image files are not copied on <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install-info</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5391">#5391</a>: A cross reference in heading is rendered as literal</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5946">#5946</a>: C++, fix <code class="docutils literal notranslate"><span class="pre">cpp:alias</span></code> problems in LaTeX (and singlehtml)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6147">#6147</a>: classes attribute of <code class="docutils literal notranslate"><span class="pre">citation_reference</span></code> node is lost</p></li>
<li><p>AssertionError is raised when custom <code class="docutils literal notranslate"><span class="pre">citation_reference</span></code> node having
classes attribute refers missing citation (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6147">#6147</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2155">#2155</a>: Support <code class="docutils literal notranslate"><span class="pre">code</span></code> directive</p></li>
<li><p>C++, fix parsing of braced initializers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6172">#6172</a>: AttributeError is raised for old styled index nodes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4872">#4872</a>: inheritance_diagram: correctly describe behavior of <code class="docutils literal notranslate"><span class="pre">parts</span></code> option in
docs, allow negative values.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6178">#6178</a>: i18n: Captions missing in translations for hidden TOCs</p></li>
</ul>
<p>2.0.0 final</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6196">#6196</a>: py domain: unexpected prefix is generated</p></li>
</ul>
</section>
<section id="id1430">
<h3>Testing<a class="headerlink" href="#id1430" title="Link to this heading">¶</a></h3>
<p>2.0.0b1</p>
<ul class="simple">
<li><p>Stop to use <code class="docutils literal notranslate"><span class="pre">SPHINX_TEST_TEMPDIR</span></code> envvar</p></li>
</ul>
<p>2.0.0b2</p>
<ul class="simple">
<li><p>Add a helper function: <code class="docutils literal notranslate"><span class="pre">sphinx.testing.restructuredtext.parse()</span></code></p></li>
</ul>
</section>
</section>
<section id="release-1-8-6-released-nov-18-2021">
<h2>Release 1.8.6 (released Nov 18, 2021)<a class="headerlink" href="#release-1-8-6-released-nov-18-2021" title="Link to this heading">¶</a></h2>
<section id="id1431">
<h3>Dependencies<a class="headerlink" href="#id1431" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/9807">#9807</a>: Restrict docutils to 0.17.x or older</p></li>
</ul>
</section>
</section>
<section id="release-1-8-5-released-mar-10-2019">
<h2>Release 1.8.5 (released Mar 10, 2019)<a class="headerlink" href="#release-1-8-5-released-mar-10-2019" title="Link to this heading">¶</a></h2>
<section id="id1433">
<h3>Bugs fixed<a class="headerlink" href="#id1433" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>LaTeX: Remove extraneous space after author names on PDF title page (refs:
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6004">#6004</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6026">#6026</a>: LaTeX: A cross reference to definition list does not work</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6046">#6046</a>: LaTeX: <code class="docutils literal notranslate"><span class="pre">TypeError</span></code> is raised when invalid latex_elements given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6067">#6067</a>: LaTeX: images having a target are concatenated to next line</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6067">#6067</a>: LaTeX: images having a target are not aligned even if specified</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6149">#6149</a>: LaTeX: <code class="docutils literal notranslate"><span class="pre">:index:</span></code> role in titles causes <code class="docutils literal notranslate"><span class="pre">Use</span> <span class="pre">of</span> <span class="pre">\@icentercr</span> <span class="pre">doesn't</span>
<span class="pre">match</span> <span class="pre">its</span> <span class="pre">definition</span></code> error on latexpdf build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6019">#6019</a>: imgconverter: Including multipage PDF fails</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6047">#6047</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">autofunction</span></code> emits a warning for method objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6028">#6028</a>: graphviz: Ensure the graphviz filenames are reproducible</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6068">#6068</a>: doctest: <code class="docutils literal notranslate"><span class="pre">skipif</span></code> option may remove the code block from documentation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6136">#6136</a>: <code class="docutils literal notranslate"><span class="pre">:name:</span></code> option for <code class="docutils literal notranslate"><span class="pre">math</span></code> directive causes a crash</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6139">#6139</a>: intersphinx: ValueError on failure reporting</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6135">#6135</a>: changes: Fix UnboundLocalError when any module found</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3859">#3859</a>: manpage: code-block captions are not displayed correctly</p></li>
</ul>
</section>
</section>
<section id="release-1-8-4-released-feb-03-2019">
<h2>Release 1.8.4 (released Feb 03, 2019)<a class="headerlink" href="#release-1-8-4-released-feb-03-2019" title="Link to this heading">¶</a></h2>
<section id="id1448">
<h3>Bugs fixed<a class="headerlink" href="#id1448" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3707">#3707</a>: latex: no bold checkmark (✔) available.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5605">#5605</a>: with the documentation language set to Chinese, English words could not
be searched.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5889">#5889</a>: LaTeX: user <code class="docutils literal notranslate"><span class="pre">numfig_format</span></code> is stripped of spaces and may cause
build failure</p></li>
<li><p>C++, fix hyperlinks for declarations involving east cv-qualifiers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5755">#5755</a>: C++, fix duplicate declaration error on function templates with
constraints in the return type.</p></li>
<li><p>C++, parse unary right fold expressions and binary fold expressions.</p></li>
<li><p>pycode could not handle egg files on windows</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5928">#5928</a>: KeyError: ‘DOCUTILSCONFIG’ when running build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5936">#5936</a>: LaTeX: PDF build broken by inclusion of image taller than page height
in an admonition</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5231">#5231</a>: “make html” does not read and build “po” files in “locale” dir</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5954">#5954</a>: <code class="docutils literal notranslate"><span class="pre">:scale:</span></code> image option may break PDF build if image in an admonition</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5966">#5966</a>: mathjax has not been loaded on incremental build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5960">#5960</a>: LaTeX: modified PDF layout since September 2018 TeXLive update of
<code class="file docutils literal notranslate"><span class="pre">parskip.sty</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5948">#5948</a>: LaTeX: duplicated labels are generated for sections</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5958">#5958</a>: versionadded directive causes crash with Python 3.5.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5995">#5995</a>: autodoc: autodoc_mock_imports conflict with metaclass on Python 3.7</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5871">#5871</a>: texinfo: a section title <code class="docutils literal notranslate"><span class="pre">.</span></code> is not allowed</p></li>
</ul>
</section>
</section>
<section id="release-1-8-3-released-dec-26-2018">
<h2>Release 1.8.3 (released Dec 26, 2018)<a class="headerlink" href="#release-1-8-3-released-dec-26-2018" title="Link to this heading">¶</a></h2>
<section id="id1463">
<h3>Features added<a class="headerlink" href="#id1463" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>LaTeX: it is possible to insert custom material to appear on back of title
page, see discussion of <code class="docutils literal notranslate"><span class="pre">'maketitle'</span></code> key of <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a>
(<code class="docutils literal notranslate"><span class="pre">'manual'</span></code> docclass only)</p></li>
</ul>
</section>
<section id="id1464">
<h3>Bugs fixed<a class="headerlink" href="#id1464" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5725">#5725</a>: mathjax: Use CDN URL for “latest” version by default</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5460">#5460</a>: html search does not work with some 3rd party themes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5520">#5520</a>: LaTeX, caption package incompatibility since Sphinx 1.6</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5614">#5614</a>: autodoc: incremental build is broken when builtin modules are imported</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5627">#5627</a>: qthelp: index.html missing in QtHelp</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5659">#5659</a>: linkcheck: crashes for a hyperlink containing multibyte character</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5754">#5754</a>: DOC: Fix some mistakes in <a class="reference internal" href="latex.html"><span class="doc">LaTeX customization</span></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5810">#5810</a>: LaTeX: sphinxVerbatim requires explicit “hllines” set-up since 1.6.6
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1238">#1238</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5636">#5636</a>: C++, fix parsing of floating point literals.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5496">#5496</a> (again): C++, fix assertion in partial builds with duplicates.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5724">#5724</a>: quickstart: sphinx-quickstart fails when $LC_ALL is empty</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1956">#1956</a>: Default conf.py is not PEP8-compliant</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5849">#5849</a>: LaTeX: document class <code class="docutils literal notranslate"><span class="pre">\maketitle</span></code> is overwritten with no
possibility to use original meaning in place of Sphinx custom one</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5834">#5834</a>: apidoc: wrong help for <code class="docutils literal notranslate"><span class="pre">--tocfile</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5800">#5800</a>: todo: crashed if todo is defined in TextElement</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5846">#5846</a>: htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files</p></li>
<li><p>htmlhelp: broken .hhk file generated when title contains a double quote</p></li>
</ul>
</section>
</section>
<section id="release-1-8-2-released-nov-11-2018">
<h2>Release 1.8.2 (released Nov 11, 2018)<a class="headerlink" href="#release-1-8-2-released-nov-11-2018" title="Link to this heading">¶</a></h2>
<section id="id1482">
<h3>Incompatible changes<a class="headerlink" href="#id1482" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5497">#5497</a>: Do not include MathJax.js and jsmath.js unless it is really needed</p></li>
</ul>
</section>
<section id="id1484">
<h3>Features added<a class="headerlink" href="#id1484" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5471">#5471</a>: Show appropriate deprecation warnings</p></li>
</ul>
</section>
<section id="id1486">
<h3>Bugs fixed<a class="headerlink" href="#id1486" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5490">#5490</a>: latex: enumerated list causes a crash with recommonmark</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5492">#5492</a>: sphinx-build fails to build docs w/ Python < 3.5.2</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3704">#3704</a>: latex: wrong <code class="docutils literal notranslate"><span class="pre">\label</span></code> positioning for figures with a legend</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5496">#5496</a>: C++, fix assertion when a symbol is declared more than twice.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5493">#5493</a>: gettext: crashed with broken template</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5495">#5495</a>: csv-table directive with file option in included file is broken (refs:
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4821">#4821</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5498">#5498</a>: autodoc: unable to find type hints for a <code class="docutils literal notranslate"><span class="pre">functools.partial</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5480">#5480</a>: autodoc: unable to find type hints for unresolvable Forward references</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5419">#5419</a>: incompatible math_block node has been generated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5548">#5548</a>: Fix ensuredir() in case of pre-existing file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5549">#5549</a>: graphviz Correctly deal with non-existing static dir</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3002">#3002</a>: i18n: multiple footnote_references referring same footnote cause
duplicated node_ids</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5563">#5563</a>: latex: footnote_references generated by extension causes a LaTeX
builder crash</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5561">#5561</a>: make all-pdf fails with old xindy version</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5557">#5557</a>: quickstart: –no-batchfile isn’t honored</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3080">#3080</a>: texinfo: multiline rubrics are broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3080">#3080</a>: texinfo: multiline citations are broken</p></li>
</ul>
</section>
</section>
<section id="release-1-8-1-released-sep-22-2018">
<h2>Release 1.8.1 (released Sep 22, 2018)<a class="headerlink" href="#release-1-8-1-released-sep-22-2018" title="Link to this heading">¶</a></h2>
<section id="id1505">
<h3>Incompatible changes<a class="headerlink" href="#id1505" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>LaTeX <code class="docutils literal notranslate"><span class="pre">\pagestyle</span></code> commands have been moved to the LaTeX template. No
changes in PDF, except possibly if <code class="docutils literal notranslate"><span class="pre">\sphinxtableofcontents</span></code>, which
contained them, had been customized in <code class="file docutils literal notranslate"><span class="pre">conf.py</span></code>. (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5455">#5455</a>)</p></li>
</ul>
</section>
<section id="id1507">
<h3>Bugs fixed<a class="headerlink" href="#id1507" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5418">#5418</a>: Incorrect default path for sphinx-build -d/doctrees files</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5421">#5421</a>: autodoc emits deprecation warning for <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_default_flags"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_default_flags</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5422">#5422</a>: lambda object causes PicklingError on storing environment</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5417">#5417</a>: Sphinx fails to build with syntax error in Python 2.7.5</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4911">#4911</a>: add latexpdf to make.bat for non make-mode</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5436">#5436</a>: Autodoc does not work with enum subclasses with properties/methods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5437">#5437</a>: autodoc: crashed on modules importing eggs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5433">#5433</a>: latex: ImportError: cannot import name ‘DEFAULT_SETTINGS’</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5431">#5431</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">autofunction</span></code> emits a warning for callable objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5457">#5457</a>: Fix TypeError in error message when override is prohibited</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5453">#5453</a>: PDF builds of ‘howto’ documents have no page numbers</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5463">#5463</a>: mathbase: math_role and MathDirective was disappeared in 1.8.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5454">#5454</a>: latex: Index has disappeared from PDF for Japanese documents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5432">#5432</a>: py domain: <code class="docutils literal notranslate"><span class="pre">:type:</span></code> field can’t process <code class="docutils literal notranslate"><span class="pre">:term:</span></code> references</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5426">#5426</a>: py domain: TypeError has been raised for class attribute</p></li>
</ul>
</section>
</section>
<section id="release-1-8-0-released-sep-13-2018">
<h2>Release 1.8.0 (released Sep 13, 2018)<a class="headerlink" href="#release-1-8-0-released-sep-13-2018" title="Link to this heading">¶</a></h2>
<section id="id1523">
<h3>Dependencies<a class="headerlink" href="#id1523" title="Link to this heading">¶</a></h3>
<p>1.8.0b1</p>
<ul class="simple">
<li><p>LaTeX: <a class="reference internal" href="usage/configuration.html#confval-latex_use_xindy"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_use_xindy</span></code></a>, if <code class="docutils literal notranslate"><span class="pre">True</span></code> (default for
<code class="docutils literal notranslate"><span class="pre">xelatex/lualatex</span></code>), instructs <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">latexpdf</span></code> to use <strong class="program">xindy</strong>
for general index. Make sure your LaTeX distribution includes it.
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5134">#5134</a>)</p></li>
<li><p>LaTeX: <code class="docutils literal notranslate"><span class="pre">latexmk</span></code> is required for <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">latexpdf</span></code> on Windows</p></li>
</ul>
</section>
<section id="id1525">
<h3>Incompatible changes<a class="headerlink" href="#id1525" title="Link to this heading">¶</a></h3>
<p>1.8.0b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5282">#5282</a>: html theme: refer <code class="docutils literal notranslate"><span class="pre">pygments_style</span></code> settings of HTML themes
preferentially</p></li>
<li><p>The URL of download files are changed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5127">#5127</a>: quickstart: <code class="docutils literal notranslate"><span class="pre">Makefile</span></code> and <code class="docutils literal notranslate"><span class="pre">make.bat</span></code> are not overwritten if exists</p></li>
</ul>
<p>1.8.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5156">#5156</a>: the <a class="reference internal" href="usage/extensions/graphviz.html#module-sphinx.ext.graphviz" title="sphinx.ext.graphviz: Support for Graphviz graphs."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.graphviz</span></code></a> extension runs <code class="docutils literal notranslate"><span class="pre">dot</span></code> in the
directory of the document being built instead of in the root directory of
the documentation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4460">#4460</a>: extensions which stores any data to environment should return the
version of its env data structure as metadata. In detail, please see
<a class="reference internal" href="extdev/index.html#ext-metadata"><span class="std std-ref">Extension metadata</span></a>.</p></li>
<li><p>Sphinx expects source parser modules to have supported file formats as
<code class="docutils literal notranslate"><span class="pre">Parser.supported</span></code> attribute</p></li>
<li><p>The default value of <a class="reference internal" href="usage/configuration.html#confval-epub_author"><code class="xref std std-confval docutils literal notranslate"><span class="pre">epub_author</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-epub_publisher"><code class="xref std std-confval docutils literal notranslate"><span class="pre">epub_publisher</span></code></a> are
changed from <code class="docutils literal notranslate"><span class="pre">'unknown'</span></code> to the value of <a class="reference internal" href="usage/configuration.html#confval-author"><code class="xref std std-confval docutils literal notranslate"><span class="pre">author</span></code></a>. This is same as
a <code class="docutils literal notranslate"><span class="pre">conf.py</span></code> file sphinx-build generates.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">gettext_compact</span></code> attribute is removed from <code class="docutils literal notranslate"><span class="pre">document.settings</span></code>
object. Please use <code class="docutils literal notranslate"><span class="pre">config.gettext_compact</span></code> instead.</p></li>
<li><p>The processing order on reading phase is changed. smart_quotes, sphinx
domains, <a class="reference internal" href="extdev/appapi.html#event-doctree-read"><code class="xref std std-event docutils literal notranslate"><span class="pre">doctree-read</span></code></a> event and versioning doctrees are invoked
earlier than so far. For more details, please read a description of
<a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.add_transform" title="sphinx.application.Sphinx.add_transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Sphinx.add_transform()</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4827">#4827</a>: All <code class="docutils literal notranslate"><span class="pre">substitution_definition</span></code> nodes are removed from doctree on
reading phase</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">docutils.conf</span></code> in <code class="docutils literal notranslate"><span class="pre">$HOME</span></code> or <code class="docutils literal notranslate"><span class="pre">/etc</span></code> directories are ignored. Only
<code class="docutils literal notranslate"><span class="pre">docutils.conf</span></code> from confdir is obeyed.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/789">#789</a>: <code class="docutils literal notranslate"><span class="pre">:samp:</span></code> role supports to escape curly braces with backslash</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4811">#4811</a>: The files under <a class="reference internal" href="usage/configuration.html#confval-html_static_path"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_static_path</span></code></a> are excluded from source
files.</p></li>
<li><p>latex: Use <code class="docutils literal notranslate"><span class="pre">\sphinxcite</span></code> for citation references instead <code class="docutils literal notranslate"><span class="pre">\hyperref</span></code></p></li>
<li><p>The config value <code class="xref std std-confval docutils literal notranslate"><span class="pre">viewcode_import</span></code> is renamed to
<a class="reference internal" href="usage/extensions/viewcode.html#confval-viewcode_follow_imported_members"><code class="xref std std-confval docutils literal notranslate"><span class="pre">viewcode_follow_imported_members</span></code></a> (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4035">#4035</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1857">#1857</a>: latex: <a class="reference internal" href="usage/configuration.html#confval-latex_show_pagerefs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_show_pagerefs</span></code></a> does not add pagerefs for
citations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4648">#4648</a>: latex: Now “rubric” elements are rendered as unnumbered section title</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4983">#4983</a>: html: The anchor for productionlist tokens has been changed</p></li>
<li><p>Modifying a template variable <code class="docutils literal notranslate"><span class="pre">script_files</span></code> in templates is allowed now.
Please use <code class="docutils literal notranslate"><span class="pre">app.add_js_file()</span></code> instead.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5072">#5072</a>: Save environment object also with only new documents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5035">#5035</a>: qthelp builder allows dashes in <a class="reference internal" href="usage/configuration.html#confval-qthelp_namespace"><code class="xref std std-confval docutils literal notranslate"><span class="pre">qthelp_namespace</span></code></a></p></li>
<li><p>LaTeX: with lualatex or xelatex use by default <strong class="program">xindy</strong> as
UTF-8 able replacement of <strong class="program">makeindex</strong> (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5134">#5134</a>). After
upgrading Sphinx, please clean latex build repertory of existing project
before new build.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5163">#5163</a>: html: hlist items are now aligned to top</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">highlightlang</span></code> directive is processed on resolving phase</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4000">#4000</a>: LaTeX: template changed. Following elements moved to it:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">\begin{document}</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">shorthandoff</span></code> variable</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">maketitle</span></code> variable</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">tableofcontents</span></code> variable</p></li>
</ul>
</li>
</ul>
</section>
<section id="id1542">
<h3>Deprecated<a class="headerlink" href="#id1542" title="Link to this heading">¶</a></h3>
<p>1.8.0b2</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.SphinxI18nReader.set_lineno_for_reporter()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.io.SphinxI18nReader.line</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.i18n.find_catalog_source_file()</span></code> has changed; the
<em>gettext_compact</em> argument has been deprecated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5403">#5403</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.util.images.guess_mimetype()</span></code> has changed; the <em>content</em>
argument has been deprecated</p></li>
</ul>
<p>1.8.0b1</p>
<ul class="simple">
<li><p><a class="reference internal" href="usage/configuration.html#confval-source_parsers"><code class="xref std std-confval docutils literal notranslate"><span class="pre">source_parsers</span></code></a> is deprecated</p></li>
<li><p><a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_default_flags"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_default_flags</span></code></a> is deprecated</p></li>
<li><p>quickstart: <code class="docutils literal notranslate"><span class="pre">--epub</span></code> option becomes default, so it is deprecated</p></li>
<li><p>Drop function based directive support. For now, Sphinx only supports class
based directives (see <a class="reference internal" href="extdev/markupapi.html#docutils.parsers.rst.Directive" title="docutils.parsers.rst.Directive"><code class="xref py py-class docutils literal notranslate"><span class="pre">Directive</span></code></a>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.docutils.directive_helper()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.cmdline</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.make_mode</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.locale.l_()</span></code> is deprecated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2157">#2157</a>: helper function <code class="docutils literal notranslate"><span class="pre">warn()</span></code> for HTML themes is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">app.override_domain()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">app.add_stylesheet()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">app.add_javascript()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">app.import_object()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">app.add_source_parser()</span></code> has changed; the <em>suffix</em> argument has been
deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.versioning.prepare()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Config.__init__()</span></code> has changed; the <em>dirname</em>, <em>filename</em> and <em>tags</em>
argument has been deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Config.check_types()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Config.check_unicode()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.application.CONFIG_FILENAME</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">highlightlang</span></code> directive is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BuildEnvironment.load()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BuildEnvironment.loads()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BuildEnvironment.frompickle()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env.read_doc()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env.update()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env._read_serial()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env._read_parallel()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env.write_doctree()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env._nitpick_ignore</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env.versionchanges</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env.dump()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env.dumps()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env.topickle()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">env.note_versionchange()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.Table.caption_footnotetexts</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.Table.header_footnotetexts</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.footnotestack</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.in_container_literal_block</span></code> is
deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.next_section_ids</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.restrict_footnote()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.check_latex_elements()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.bibitems</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.LaTeXTranslator.hlsettingstack</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.latex.ExtBabel.get_shorthandoff()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html.HTMLTranslator.highlightlang</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html.HTMLTranslator.highlightlang_base</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html.HTMLTranslator.highlightlangopts</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html.HTMLTranslator.highlightlinenothreshold</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html5.HTMLTranslator.highlightlang</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html5.HTMLTranslator.highlightlang_base</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html5.HTMLTranslator.highlightlangopts</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase</span></code> extension is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.math</span></code> node is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.displaymath</span></code> node is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.eqref</span></code> node is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.is_in_section_title()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.MathDomain</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.MathDirective</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.math_role</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.setup_math()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.directives.other.VersionChanges</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.highlighting.PygmentsBridge.unhighlight()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.get_node_equation_number()</span></code> is deprecated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase.wrap_displaymath()</span></code> is deprecated</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">trim_doctest_flags</span></code> argument of <code class="docutils literal notranslate"><span class="pre">sphinx.highlighting.PygmentsBridge</span></code>
is deprecated</p></li>
</ul>
<p>For more details, see <a class="reference internal" href="extdev/deprecated.html#dev-deprecated-apis"><span class="std std-ref">deprecation APIs list</span></a>.</p>
</section>
<section id="id1545">
<h3>Features added<a class="headerlink" href="#id1545" title="Link to this heading">¶</a></h3>
<p>1.8.0b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5388">#5388</a>: Ensure frozen object descriptions are reproducible</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5362">#5362</a>: apidoc: Add <code class="docutils literal notranslate"><span class="pre">--tocfile</span></code> option to change the filename of ToC</p></li>
</ul>
<p>1.8.0b1</p>
<ul class="simple">
<li><p>Add <a class="reference internal" href="extdev/appapi.html#event-config-inited"><code class="xref std std-event docutils literal notranslate"><span class="pre">config-inited</span></code></a> event</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">sphinx.config.Any</span></code> to represent the config value accepts any type of
value</p></li>
<li><p><a class="reference internal" href="usage/configuration.html#confval-source_suffix"><code class="xref std std-confval docutils literal notranslate"><span class="pre">source_suffix</span></code></a> allows a mapping fileext to file types</p></li>
<li><p>Add <a class="reference internal" href="usage/configuration.html#confval-author"><code class="xref std std-confval docutils literal notranslate"><span class="pre">author</span></code></a> as a configuration value</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2852">#2852</a>: imgconverter: Support to convert GIF to PNG</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx-build</span></code> command supports i18n console output</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">app.add_message_catalog()</span></code> and <code class="docutils literal notranslate"><span class="pre">sphinx.locale.get_translations()</span></code> to
support translation for 3rd party extensions</p></li>
<li><p>helper function <code class="docutils literal notranslate"><span class="pre">warning()</span></code> for HTML themes is added</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">Domain.enumerable_nodes</span></code> to manage own enumerable nodes for domains
(experimental)</p></li>
<li><p>Add a new keyword argument <code class="docutils literal notranslate"><span class="pre">override</span></code> to Application APIs</p></li>
<li><p>LaTeX: new key <code class="docutils literal notranslate"><span class="pre">'fvset'</span></code> for <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a>. For
XeLaTeX/LuaLaTeX its default sets <code class="docutils literal notranslate"><span class="pre">fanvyvrb</span></code> to use normal, not small,
fontsize in code-blocks (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4793">#4793</a>)</p></li>
<li><p>Add <a class="reference internal" href="usage/configuration.html#confval-html_css_files"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_css_files</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-epub_css_files"><code class="xref std std-confval docutils literal notranslate"><span class="pre">epub_css_files</span></code></a> for adding CSS
files from configuration</p></li>
<li><p>Add <a class="reference internal" href="usage/configuration.html#confval-html_js_files"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_js_files</span></code></a> for adding JS files from configuration</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4834">#4834</a>: Ensure set object descriptions are reproducible.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4828">#4828</a>: Allow to override <a class="reference internal" href="usage/configuration.html#confval-numfig_format"><code class="xref std std-confval docutils literal notranslate"><span class="pre">numfig_format</span></code></a> partially. Full definition
is not needed.</p></li>
<li><p>Improve warning messages during including (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4818">#4818</a>)</p></li>
<li><p>LaTeX: separate customizability of <a class="reference internal" href="usage/restructuredtext/roles.html#role-guilabel" title="guilabel role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">guilabel</span></code></a> and
<a class="reference internal" href="usage/restructuredtext/roles.html#role-menuselection" title="menuselection role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">menuselection</span></code></a> (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4830">#4830</a>)</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">Config.read()</span></code> classmethod to create a new config object from
configuration file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4866">#4866</a>: Wrap graphviz diagrams in <code class="docutils literal notranslate"><span class="pre"><div></span></code> tag</p></li>
<li><p>viewcode: Add <a class="reference internal" href="usage/extensions/viewcode.html#event-viewcode-find-source"><code class="xref std std-event docutils literal notranslate"><span class="pre">viewcode-find-source</span></code></a> and
<a class="reference internal" href="usage/extensions/viewcode.html#event-viewcode-follow-imported"><code class="xref std std-event docutils literal notranslate"><span class="pre">viewcode-follow-imported</span></code></a> to load source code without loading</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4785">#4785</a>: napoleon: Add strings to translation file for localisation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4927">#4927</a>: Display a warning when invalid values are passed to linenothreshold
option of highlight directive</p></li>
<li><p>C++:</p>
<ul>
<li><p>Add a <code class="docutils literal notranslate"><span class="pre">cpp:texpr</span></code> role as a sibling to <code class="docutils literal notranslate"><span class="pre">cpp:expr</span></code>.</p></li>
<li><p>Add support for unions.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3593">#3593</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2683">#2683</a>: add support for anonymous entities using names staring with
<code class="docutils literal notranslate"><span class="pre">@</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5147">#5147</a>: add support for (most) character literals.</p></li>
<li><p>Cross-referencing entities inside primary templates is supported,
and now properly documented.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1552">#1552</a>: add new cross-referencing format for <code class="docutils literal notranslate"><span class="pre">cpp:any</span></code> and <code class="docutils literal notranslate"><span class="pre">cpp:func</span></code>
roles, for referencing specific function overloads.</p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3606">#3606</a>: MathJax should be loaded with async attribute</p></li>
<li><p>html: Output <code class="docutils literal notranslate"><span class="pre">canonical_url</span></code> metadata if <a class="reference internal" href="usage/configuration.html#confval-html_baseurl"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_baseurl</span></code></a> set (refs:
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4193">#4193</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5029">#5029</a>: autosummary: expose <code class="docutils literal notranslate"><span class="pre">inherited_members</span></code> to template</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3784">#3784</a>: mathjax: Add <a class="reference internal" href="usage/extensions/math.html#confval-mathjax_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mathjax_options</span></code></a> to give options to script tag
for mathjax</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/726">#726</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/969">#969</a>: mathjax: Add <a class="reference internal" href="usage/extensions/math.html#confval-mathjax_config"><code class="xref std std-confval docutils literal notranslate"><span class="pre">mathjax_config</span></code></a> to give in-line
configurations for mathjax</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4362">#4362</a>: latex: Don’t overwrite .tex file if document not changed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1431">#1431</a>: latex: Add alphanumeric enumerated list support</p></li>
<li><p>Add <a class="reference internal" href="usage/configuration.html#confval-latex_use_xindy"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_use_xindy</span></code></a> for UTF-8 savvy indexing, defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code>
if <a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a> is <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code> or <code class="docutils literal notranslate"><span class="pre">'lualatex'</span></code>. (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5134">#5134</a>,
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5192">#5192</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5212">#5212</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4976">#4976</a>: <code class="docutils literal notranslate"><span class="pre">SphinxLoggerAdapter.info()</span></code> now supports <code class="docutils literal notranslate"><span class="pre">location</span></code> parameter</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5122">#5122</a>: setuptools: support nitpicky option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2820">#2820</a>: autoclass directive supports nested class</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">app.add_html_math_renderer()</span></code> to register a math renderer for HTML</p></li>
<li><p>Apply <a class="reference internal" href="usage/configuration.html#confval-trim_doctest_flags"><code class="xref std std-confval docutils literal notranslate"><span class="pre">trim_doctest_flags</span></code></a> to all builders (cf. text, manpages)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5140">#5140</a>: linkcheck: Add better Accept header to HTTP client</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4614">#4614</a>: sphinx-build: Add <code class="docutils literal notranslate"><span class="pre">--keep-going</span></code> option to show all warnings</p></li>
<li><p>Add <a class="reference internal" href="usage/restructuredtext/domains.html#role-math-numref" title="math:numref role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">math:numref</span></code></a> role to refer equations (Same as <a class="reference internal" href="usage/restructuredtext/roles.html#role-eq" title="eq role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">eq</span></code></a>)</p></li>
<li><p>quickstart: epub builder is enabled by default</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5246">#5246</a>: Add <a class="reference internal" href="usage/configuration.html#confval-singlehtml_sidebars"><code class="xref std std-confval docutils literal notranslate"><span class="pre">singlehtml_sidebars</span></code></a> to configure sidebars for singlehtml
builder</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5273">#5273</a>: doctest: Skip doctest conditionally</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5306">#5306</a>: autodoc: emit a warning for invalid typehints</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4075">#4075</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5215">#5215</a>: autodoc: Add <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_default_options"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_default_options</span></code></a> which accepts
option values as dict</p></li>
</ul>
</section>
<section id="id1582">
<h3>Bugs fixed<a class="headerlink" href="#id1582" title="Link to this heading">¶</a></h3>
<p>1.8.0b2</p>
<ul class="simple">
<li><p>html: search box overrides to other elements if scrolled</p></li>
<li><p>i18n: warnings for translation catalogs have wrong line numbers (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5321">#5321</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5325">#5325</a>: latex: cross references has been broken by multiply labeled objects</p></li>
<li><p>C++, fixes for symbol addition and lookup. Lookup should no longer break
in partial builds. See also <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5337">#5337</a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5348">#5348</a>: download reference to remote file is not displayed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5282">#5282</a>: html theme: <code class="docutils literal notranslate"><span class="pre">pygments_style</span></code> of theme was overridden by <code class="docutils literal notranslate"><span class="pre">conf.py</span></code>
by default</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4379">#4379</a>: toctree shows confusing warning when document is excluded</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2401">#2401</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">:members:</span></code> causes <code class="docutils literal notranslate"><span class="pre">:special-members:</span></code> not to be shown</p></li>
<li><p>autodoc: ImportError is replaced by AttributeError for deeper module</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2720">#2720</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4034">#4034</a>: Incorrect links with <code class="docutils literal notranslate"><span class="pre">:download:</span></code>, duplicate names, and
parallel builds</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5290">#5290</a>: autodoc: failed to analyze source code in egg package</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5399">#5399</a>: Sphinx crashes if unknown po file exists</p></li>
</ul>
<p>1.8.0b1</p>
<ul class="simple">
<li><p>i18n: message catalogs were reset on each initialization</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4850">#4850</a>: latex: footnote inside footnote was not rendered</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4945">#4945</a>: i18n: fix lang_COUNTRY not fallback correctly for IndexBuilder. Thanks
to Shengjing Zhu.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4983">#4983</a>: productionlist directive generates invalid IDs for the tokens</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5132">#5132</a>: lualatex: PDF build fails if indexed word starts with Unicode character</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5133">#5133</a>: latex: index headings “Symbols” and “Numbers” not internationalized</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5114">#5114</a>: sphinx-build: Handle errors on scanning documents</p></li>
<li><p>epub: spine has been broken when “self” is listed on toctree (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4611">#4611</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/344">#344</a>: autosummary does not understand docstring of module level attributes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5191">#5191</a>: C++, prevent nested declarations in functions to avoid lookup problems.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5126">#5126</a>: C++, add missing isPack method for certain template parameter types.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5187">#5187</a>: C++, parse attributes on declarators as well.</p></li>
<li><p>C++, parse delete expressions and basic new expressions as well.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5002">#5002</a>: graphviz: SVGs do not adapt to the column width</p></li>
</ul>
</section>
<section id="features-removed">
<h3>Features removed<a class="headerlink" href="#features-removed" title="Link to this heading">¶</a></h3>
<p>1.8.0b1</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.pngmath</span></code> extension</p></li>
</ul>
</section>
<section id="documentation">
<h3>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">¶</a></h3>
<p>1.8.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5083">#5083</a>: Fix wrong make.bat option for internationalization.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5115">#5115</a>: napoleon: add admonitions added by <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4613">#4613</a> to the docs.</p></li>
</ul>
</section>
</section>
<section id="release-1-7-9-released-sep-05-2018">
<h2>Release 1.7.9 (released Sep 05, 2018)<a class="headerlink" href="#release-1-7-9-released-sep-05-2018" title="Link to this heading">¶</a></h2>
<section id="id1609">
<h3>Features added<a class="headerlink" href="#id1609" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5359">#5359</a>: Make generated texinfo files reproducible by sorting the anchors</p></li>
</ul>
</section>
<section id="id1611">
<h3>Bugs fixed<a class="headerlink" href="#id1611" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5361">#5361</a>: crashed on incremental build if document uses include directive</p></li>
</ul>
</section>
</section>
<section id="release-1-7-8-released-aug-29-2018">
<h2>Release 1.7.8 (released Aug 29, 2018)<a class="headerlink" href="#release-1-7-8-released-aug-29-2018" title="Link to this heading">¶</a></h2>
<section id="id1613">
<h3>Incompatible changes<a class="headerlink" href="#id1613" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>The type of <code class="docutils literal notranslate"><span class="pre">env.included</span></code> has been changed to dict of set</p></li>
</ul>
</section>
<section id="id1614">
<h3>Bugs fixed<a class="headerlink" href="#id1614" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5320">#5320</a>: intersphinx: crashed if invalid url given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5326">#5326</a>: manpage: crashed when invalid docname is specified as <code class="docutils literal notranslate"><span class="pre">man_pages</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5322">#5322</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">Any</span></code> typehint causes formatting error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5327">#5327</a>: “document isn’t included in any toctree” warning on rebuild with
generated files</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5335">#5335</a>: quickstart: escape sequence has been displayed with MacPorts’ python</p></li>
</ul>
</section>
</section>
<section id="release-1-7-7-released-aug-19-2018">
<h2>Release 1.7.7 (released Aug 19, 2018)<a class="headerlink" href="#release-1-7-7-released-aug-19-2018" title="Link to this heading">¶</a></h2>
<section id="id1620">
<h3>Bugs fixed<a class="headerlink" href="#id1620" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5198">#5198</a>: document not in toctree warning when including files only for parallel
builds</p></li>
<li><p>LaTeX: reduce “Token not allowed in a PDF string” hyperref warnings in latex
console output (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5236">#5236</a>)</p></li>
<li><p>LaTeX: suppress “remreset Warning: The remreset package is obsolete” in latex
console output with recent LaTeX (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5237">#5237</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5234">#5234</a>: PDF output: usage of PAPER environment variable is broken since Sphinx
1.5</p></li>
<li><p>LaTeX: fix the <a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a> documentation regarding Latin Modern
font with XeLaTeX/LuaLateX (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5251">#5251</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5280">#5280</a>: autodoc: Fix wrong type annotations for complex typing</p></li>
<li><p>autodoc: Optional types are wrongly rendered</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5291">#5291</a>: autodoc crashed by ForwardRef types</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5211">#5211</a>: autodoc: No docs generated for functools.partial functions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5306">#5306</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">getargspec()</span></code> raises NameError for invalid typehints</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5298">#5298</a>: imgmath: math_number_all causes equations to have two numbers in html</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5294">#5294</a>: sphinx-quickstart blank prompts in PowerShell</p></li>
</ul>
</section>
</section>
<section id="release-1-7-6-released-jul-17-2018">
<h2>Release 1.7.6 (released Jul 17, 2018)<a class="headerlink" href="#release-1-7-6-released-jul-17-2018" title="Link to this heading">¶</a></h2>
<section id="id1632">
<h3>Bugs fixed<a class="headerlink" href="#id1632" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5037">#5037</a>: LaTeX <code class="docutils literal notranslate"><span class="pre">\sphinxupquote{}</span></code> breaks in Russian</p></li>
<li><p>sphinx.testing uses deprecated pytest API; <code class="docutils literal notranslate"><span class="pre">Node.get_marker(name)</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5016">#5016</a>: crashed when recommonmark.AutoStrictify is enabled</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5022">#5022</a>: latex: crashed with docutils package provided by Debian/Ubuntu</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5009">#5009</a>: latex: a label for table is vanished if table does not have a caption</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5048">#5048</a>: crashed with numbered toctree</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2410">#2410</a>: C, render empty argument lists for macros.</p></li>
<li><p>C++, fix lookup of full template specializations with no template arguments.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4667">#4667</a>: C++, fix assertion on missing references in global scope when using
intersphinx. Thanks to Alan M. Carroll.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5019">#5019</a>: autodoc: crashed by Form Feed Character</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5032">#5032</a>: autodoc: loses the first staticmethod parameter for old styled classes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5036">#5036</a>: quickstart: Typing Ctrl-U clears the whole of line</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5066">#5066</a>: html: “relations” sidebar is not shown by default</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5091">#5091</a>: latex: curly braces in index entries are not handled correctly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5070">#5070</a>: epub: Wrong internal href fragment links</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5104">#5104</a>: apidoc: Interface of <code class="docutils literal notranslate"><span class="pre">sphinx.apidoc:main()</span></code> has changed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4272">#4272</a>: PDF builds of French projects have issues with XeTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5076">#5076</a>: napoleon raises RuntimeError with python 3.7</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5125">#5125</a>: sphinx-build: Interface of <code class="docutils literal notranslate"><span class="pre">sphinx:main()</span></code> has changed</p></li>
<li><p>sphinx-build: <code class="docutils literal notranslate"><span class="pre">sphinx.cmd.build.main()</span></code> refers <code class="docutils literal notranslate"><span class="pre">sys.argv</span></code> instead of given
argument</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5146">#5146</a>: autosummary: warning is emitted when the first line of docstring ends
with literal notation</p></li>
<li><p>autosummary: warnings of autosummary indicates wrong location (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5146">#5146</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5143">#5143</a>: autodoc: crashed on inspecting dict like object which does not support
sorting</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5139">#5139</a>: autodoc: Enum argument missing if it shares value with another</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4946">#4946</a>: py domain: rtype field could not handle “None” as a type</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5176">#5176</a>: LaTeX: indexing of terms containing <code class="docutils literal notranslate"><span class="pre">@</span></code>, <code class="docutils literal notranslate"><span class="pre">!</span></code>, or <code class="docutils literal notranslate"><span class="pre">"</span></code> fails</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5161">#5161</a>: html: crashes if copying static files are failed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5167">#5167</a>: autodoc: Fix formatting type annotations for tuples with more than two
arguments</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3329">#3329</a>: i18n: crashed by auto-symbol footnote references</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5158">#5158</a>: autosummary: module summary has been broken when it starts with heading</p></li>
</ul>
</section>
</section>
<section id="release-1-7-5-released-may-29-2018">
<h2>Release 1.7.5 (released May 29, 2018)<a class="headerlink" href="#release-1-7-5-released-may-29-2018" title="Link to this heading">¶</a></h2>
<section id="id1660">
<h3>Bugs fixed<a class="headerlink" href="#id1660" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4924">#4924</a>: html search: Upper characters problem in any other languages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4932">#4932</a>: apidoc: some subpackage is ignored if sibling subpackage contains a
module starting with underscore</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4863">#4863</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4938">#4938</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4939">#4939</a>: i18n doesn’t handle correctly node.title as used for
contents, topic, admonition, table and section.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4913">#4913</a>: i18n: literal blocks in bullet list are not translated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4962">#4962</a>: C++, raised TypeError on duplicate declaration.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4825">#4825</a>: C++, properly parse expr roles and give better error messages when
(escaped) line breaks are present.</p></li>
<li><p>C++, properly use <code class="docutils literal notranslate"><span class="pre">desc_addname</span></code> nodes for prefixes of names.</p></li>
<li><p>C++, parse pack expansions in function calls.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4915">#4915</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4916">#4916</a>: links on search page are broken when using dirhtml builder</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4969">#4969</a>: autodoc: constructor method should not have return annotation</p></li>
<li><p>latex: deeply nested enumerated list which is beginning with non-1 causes
LaTeX engine crashed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4978">#4978</a>: latex: shorthandoff is not set up for Brazil locale</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4928">#4928</a>: i18n: Ignore dot-directories like .git/ in LC_MESSAGES/</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4946">#4946</a>: py domain: type field could not handle “None” as a type</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4979">#4979</a>: latex: Incorrect escaping of curly braces in index entries</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4956">#4956</a>: autodoc: Failed to extract document from a subclass of the class on
mocked module</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4973">#4973</a>: latex: glossary directive adds whitespace to each item</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4980">#4980</a>: latex: Explicit labels on code blocks are duplicated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4919">#4919</a>: node.asdom() crashes if toctree has :numbered: option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4914">#4914</a>: autodoc: Parsing error when using dataclasses without default values</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4931">#4931</a>: autodoc: crashed when handler for autodoc-skip-member raises an error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4931">#4931</a>: autodoc: crashed when subclass of mocked class are processed by
napoleon module</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/5007">#5007</a>: sphinx-build crashes when error log contains a “%” character</p></li>
</ul>
</section>
</section>
<section id="release-1-7-4-released-apr-25-2018">
<h2>Release 1.7.4 (released Apr 25, 2018)<a class="headerlink" href="#release-1-7-4-released-apr-25-2018" title="Link to this heading">¶</a></h2>
<section id="id1684">
<h3>Bugs fixed<a class="headerlink" href="#id1684" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4885">#4885</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4887">#4887</a>: domains: Crashed with duplicated objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4889">#4889</a>: latex: sphinx.writers.latex causes recursive import</p></li>
</ul>
</section>
</section>
<section id="release-1-7-3-released-apr-23-2018">
<h2>Release 1.7.3 (released Apr 23, 2018)<a class="headerlink" href="#release-1-7-3-released-apr-23-2018" title="Link to this heading">¶</a></h2>
<section id="id1688">
<h3>Bugs fixed<a class="headerlink" href="#id1688" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4769">#4769</a>: autodoc loses the first staticmethod parameter</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4790">#4790</a>: autosummary: too wide two column tables in PDF builds</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4795">#4795</a>: Latex customization via <code class="docutils literal notranslate"><span class="pre">_templates/longtable.tex_t</span></code> is broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4789">#4789</a>: imgconverter: confused by convert.exe of Windows</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4783">#4783</a>: On windows, Sphinx crashed when drives of srcdir and outdir are
different</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4812">#4812</a>: autodoc ignores type annotated variables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4817">#4817</a>: wrong URLs on warning messages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4784">#4784</a>: latex: <a class="reference internal" href="usage/configuration.html#confval-latex_show_urls"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_show_urls</span></code></a> assigns incorrect footnote numbers if
hyperlinks exists inside substitutions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4837">#4837</a>: latex with class memoir Error: Font command <code class="docutils literal notranslate"><span class="pre">\sf</span></code> is not supported</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4803">#4803</a>: latex: too slow in proportion to number of auto numbered footnotes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4838">#4838</a>: htmlhelp: The entries in .hhp file is not ordered</p></li>
<li><p>toctree directive tries to glob for URL having query_string</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4871">#4871</a>: html search: Upper characters problem in German</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4717">#4717</a>: latex: Compilation for German docs failed with LuaLaTeX and XeLaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4459">#4459</a>: duplicated labels detector does not work well in parallel build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4878">#4878</a>: Crashed with extension which returns invalid metadata</p></li>
</ul>
</section>
</section>
<section id="release-1-7-2-released-mar-21-2018">
<h2>Release 1.7.2 (released Mar 21, 2018)<a class="headerlink" href="#release-1-7-2-released-mar-21-2018" title="Link to this heading">¶</a></h2>
<section id="id1704">
<h3>Incompatible changes<a class="headerlink" href="#id1704" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4520">#4520</a>: apidoc: folders with an empty __init__.py are no longer excluded from
TOC</p></li>
</ul>
</section>
<section id="id1706">
<h3>Bugs fixed<a class="headerlink" href="#id1706" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4669">#4669</a>: sphinx.build_main and sphinx.make_main throw NameError</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4685">#4685</a>: autosummary emits meaningless warnings</p></li>
<li><p>autodoc: crashed when invalid options given</p></li>
<li><p>pydomain: always strip parenthesis if empty (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1042">#1042</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4689">#4689</a>: autosummary: unexpectedly strips docstrings containing “i.e.”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4701">#4701</a>: viewcode: Misplaced <code class="docutils literal notranslate"><span class="pre"><div></span></code> in viewcode html output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4444">#4444</a>: Don’t require numfig to use :numref: on sections</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4727">#4727</a>: Option clash for package textcomp</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4725">#4725</a>: Sphinx does not work with python 3.5.0 and 3.5.1</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4716">#4716</a>: Generation PDF file with TexLive on Windows, file not found error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4574">#4574</a>: vertical space before equation in latex</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4720">#4720</a>: message when an image is mismatched for builder is not clear</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4655">#4655</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4684">#4684</a>: Incomplete localization strings in Polish and Chinese</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2286">#2286</a>: Sphinx crashes when error is happens in rendering HTML pages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4688">#4688</a>: Error to download remote images having long URL</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4754">#4754</a>: sphinx/pycode/__init__.py raises AttributeError</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1435">#1435</a>: qthelp builder should htmlescape keywords</p></li>
<li><p>epub: Fix docTitle elements of toc.ncx is not escaped</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4520">#4520</a>: apidoc: Subpackage not in toc (introduced in 1.6.6) now fixed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4767">#4767</a>: html: search highlighting breaks mathjax equations</p></li>
</ul>
</section>
</section>
<section id="release-1-7-1-released-feb-23-2018">
<h2>Release 1.7.1 (released Feb 23, 2018)<a class="headerlink" href="#release-1-7-1-released-feb-23-2018" title="Link to this heading">¶</a></h2>
<section id="id1726">
<h3>Deprecated<a class="headerlink" href="#id1726" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4623">#4623</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.build_main()</span></code> is deprecated.</p></li>
<li><p>autosummary: The interface of <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.get_documenter()</span></code> has
been changed (Since 1.7.0)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4664">#4664</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx.debug()</span></code> is deprecated.</p></li>
</ul>
<p>For more details, see <a class="reference internal" href="extdev/deprecated.html#dev-deprecated-apis"><span class="std std-ref">deprecation APIs list</span></a>.</p>
</section>
<section id="id1729">
<h3>Bugs fixed<a class="headerlink" href="#id1729" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4608">#4608</a>: epub: Invalid meta tag is generated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4260">#4260</a>: autodoc: keyword only argument separator is not disappeared if it is
appeared at top of the argument list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4622">#4622</a>: epub: <a class="reference internal" href="usage/configuration.html#confval-epub_scheme"><code class="xref std std-confval docutils literal notranslate"><span class="pre">epub_scheme</span></code></a> does not effect to content.opf</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4627">#4627</a>: graphviz: Fit graphviz images to page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4617">#4617</a>: quickstart: PROJECT_DIR argument is required</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4623">#4623</a>: sphinx.build_main no longer exists in 1.7.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4615">#4615</a>: The argument of <code class="docutils literal notranslate"><span class="pre">sphinx.build</span></code> has been changed in 1.7.0</p></li>
<li><p>autosummary: The interface of <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary.get_documenter()</span></code> has
been changed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4630">#4630</a>: Have order on msgids in sphinx.pot deterministic</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4563">#4563</a>: autosummary: Incorrect end of line punctuation detection</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4577">#4577</a>: Enumerated sublists with explicit start with wrong number</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4641">#4641</a>: A external link in TOC cannot contain “?” with <code class="docutils literal notranslate"><span class="pre">:glob:</span></code> option</p></li>
<li><p>C++, add missing parsing of explicit casts and typeid in expression parsing.</p></li>
<li><p>C++, add missing parsing of <code class="docutils literal notranslate"><span class="pre">this</span></code> in expression parsing.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4655">#4655</a>: Fix incomplete localization strings in Polish</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4653">#4653</a>: Fix error reporting for parameterless ImportErrors</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4664">#4664</a>: Reading objects.inv fails again</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4662">#4662</a>: <code class="docutils literal notranslate"><span class="pre">any</span></code> refs with <code class="docutils literal notranslate"><span class="pre">term</span></code> targets crash when an ambiguity is
encountered</p></li>
</ul>
</section>
</section>
<section id="release-1-7-0-released-feb-12-2018">
<h2>Release 1.7.0 (released Feb 12, 2018)<a class="headerlink" href="#release-1-7-0-released-feb-12-2018" title="Link to this heading">¶</a></h2>
<section id="id1745">
<h3>Dependencies<a class="headerlink" href="#id1745" title="Link to this heading">¶</a></h3>
<p>1.7.0b1</p>
<ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">packaging</span></code> package</p></li>
</ul>
</section>
<section id="id1746">
<h3>Incompatible changes<a class="headerlink" href="#id1746" title="Link to this heading">¶</a></h3>
<p>1.7.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3668">#3668</a>: The arguments has changed of main functions for each command</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3893">#3893</a>: Unknown html_theme_options throw warnings instead of errors</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3927">#3927</a>: Python parameter/variable types should match classes, not all objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3962">#3962</a>: sphinx-apidoc now recognizes given directory as an implicit namespace
package when <code class="docutils literal notranslate"><span class="pre">--implicit-namespaces</span></code> option given, not subdirectories of
given directory.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3929">#3929</a>: apidoc: Move sphinx.apidoc to sphinx.ext.apidoc</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4226">#4226</a>: apidoc: Generate new style makefile (make-mode)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4274">#4274</a>: sphinx-build returns 2 as an exit code on argument error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4389">#4389</a>: output directory will be created after loading extensions</p></li>
<li><p>autodoc does not generate warnings messages to the generated document even if
<a class="reference internal" href="usage/configuration.html#confval-keep_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">keep_warnings</span></code></a> is True. They are only emitted to stderr.</p></li>
<li><p>shebang line is removed from generated conf.py</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2557">#2557</a>: autodoc: <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_mock_imports"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_mock_imports</span></code></a> 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.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3620">#3620</a>: html theme: move DOCUMENTATION_OPTIONS to independent JavaScript file
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4295">#4295</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4246">#4246</a>: Limit width of text body for all themes. Configurable via theme
options <code class="docutils literal notranslate"><span class="pre">body_min_width</span></code> and <code class="docutils literal notranslate"><span class="pre">body_max_width</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4771">#4771</a>: apidoc: The <code class="docutils literal notranslate"><span class="pre">exclude_patterns</span></code> arguments are ignored if they are
placed just after command line options</p></li>
</ul>
<p>1.7.0b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4467">#4467</a>: html theme: Rename <code class="docutils literal notranslate"><span class="pre">csss</span></code> block to <code class="docutils literal notranslate"><span class="pre">css</span></code></p></li>
</ul>
</section>
<section id="id1761">
<h3>Deprecated<a class="headerlink" href="#id1761" title="Link to this heading">¶</a></h3>
<p>1.7.0b1</p>
<ul class="simple">
<li><p>using a string value for <a class="reference internal" href="usage/configuration.html#confval-html_sidebars"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_sidebars</span></code></a> is deprecated and only list
values will be accepted at 2.0.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">format_annotation()</span></code> and <code class="docutils literal notranslate"><span class="pre">formatargspec()</span></code> is deprecated. Please use
<code class="docutils literal notranslate"><span class="pre">sphinx.util.inspect.Signature</span></code> instead.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.AutodocReporter</span></code> is replaced by <code class="docutils literal notranslate"><span class="pre">sphinx.util.docutils.</span>
<span class="pre">switch_source_input()</span></code> and now deprecated. It will be removed in Sphinx 2.0.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.add_documenter()</span></code> and <code class="docutils literal notranslate"><span class="pre">AutoDirective._register</span></code> is now
deprecated. Please use <code class="docutils literal notranslate"><span class="pre">app.add_autodocumenter()</span></code> instead.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">AutoDirective._special_attrgetters</span></code> is now deprecated. Please use
<code class="docutils literal notranslate"><span class="pre">app.add_autodoc_attrgetter()</span></code> instead.</p></li>
</ul>
</section>
<section id="id1762">
<h3>Features added<a class="headerlink" href="#id1762" title="Link to this heading">¶</a></h3>
<p>1.7.0b1</p>
<ul class="simple">
<li><p>C++, handle <code class="docutils literal notranslate"><span class="pre">decltype(auto)</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2406">#2406</a>: C++, add proper parsing of expressions, including linking of
identifiers.</p></li>
<li><p>C++, add a <code class="docutils literal notranslate"><span class="pre">cpp:expr</span></code> role for inserting inline C++ expressions or types.</p></li>
<li><p>C++, support explicit member instantiations with shorthand <code class="docutils literal notranslate"><span class="pre">template</span></code> prefix</p></li>
<li><p>C++, make function parameters linkable, like template params.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3638">#3638</a>: Allow to change a label of reference to equation using
<code class="docutils literal notranslate"><span class="pre">math_eqref_format</span></code></p></li>
<li><p>Now <a class="reference internal" href="usage/configuration.html#confval-suppress_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">suppress_warnings</span></code></a> accepts following configurations:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">ref.python</span></code> (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3866">#3866</a>)</p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3872">#3872</a>: Add latex key to configure literal blocks caption position in PDF
output (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3792">#3792</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1723">#1723</a>)</p></li>
<li><p>In case of missing docstring try to retrieve doc from base classes (ref:
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3140">#3140</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4023">#4023</a>: Clarify error message when any role has more than one target.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3973">#3973</a>: epub: allow to override build date</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3972">#3972</a>: epub: Sort manifest entries by filename</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4052">#4052</a>: viewcode: Sort before highlighting module code</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1448">#1448</a>: qthelp: Add new config value; <a class="reference internal" href="usage/configuration.html#confval-qthelp_namespace"><code class="xref std std-confval docutils literal notranslate"><span class="pre">qthelp_namespace</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4140">#4140</a>: html themes: Make body tag inheritable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4168">#4168</a>: improve zh search with jieba</p></li>
<li><p>HTML themes can set up default sidebars through <code class="docutils literal notranslate"><span class="pre">theme.conf</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3160">#3160</a>: html: Use <code class="docutils literal notranslate"><span class="pre"><kdb></span></code> to represent <code class="docutils literal notranslate"><span class="pre">:kbd:</span></code> role</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4212">#4212</a>: autosummary: catch all exceptions when importing modules</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4166">#4166</a>: Add <a class="reference internal" href="usage/configuration.html#confval-math_numfig"><code class="xref std std-confval docutils literal notranslate"><span class="pre">math_numfig</span></code></a> for equation numbering by section (refs:
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3991">#3991</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4080">#4080</a>). Thanks to Oliver Jahn.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4311">#4311</a>: Let LaTeX obey <a class="reference internal" href="usage/configuration.html#confval-numfig_secnum_depth"><code class="xref std std-confval docutils literal notranslate"><span class="pre">numfig_secnum_depth</span></code></a> for figures, tables, and
code-blocks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/947">#947</a>: autodoc now supports ignore-module-all to ignore a module’s <code class="docutils literal notranslate"><span class="pre">__all__</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4332">#4332</a>: Let LaTeX obey <a class="reference internal" href="usage/configuration.html#confval-math_numfig"><code class="xref std std-confval docutils literal notranslate"><span class="pre">math_numfig</span></code></a> for equation numbering</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4093">#4093</a>: sphinx-build creates empty directories for unknown targets/builders</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">top-classes</span></code> option for the <code class="docutils literal notranslate"><span class="pre">sphinx.ext.inheritance_diagram</span></code>
extension to limit the scope of inheritance graphs.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4183">#4183</a>: doctest: <code class="docutils literal notranslate"><span class="pre">:pyversion:</span></code> option also follows PEP-440 specification</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4235">#4235</a>: html: Add <a class="reference internal" href="usage/configuration.html#confval-manpages_url"><code class="xref std std-confval docutils literal notranslate"><span class="pre">manpages_url</span></code></a> to make manpage roles to hyperlinks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3570">#3570</a>: autodoc: Do not display ‘typing.’ module for type hints</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4354">#4354</a>: sphinx-build now emits finish message. Builders can modify it through
<code class="docutils literal notranslate"><span class="pre">Builder.epilog</span></code> attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4245">#4245</a>: html themes: Add <code class="docutils literal notranslate"><span class="pre">language</span></code> to javascript vars list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4079">#4079</a>: html: Add <code class="docutils literal notranslate"><span class="pre">notranslate</span></code> class to each code-blocks, literals and maths
to let Google Translate know they are not translatable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4137">#4137</a>: doctest: doctest block is always highlighted as python console (pycon)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4137">#4137</a>: doctest: testcode block is always highlighted as python</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3998">#3998</a>: text: Assign section numbers by default. You can control it using
<a class="reference internal" href="usage/configuration.html#confval-text_add_secnumbers"><code class="xref std std-confval docutils literal notranslate"><span class="pre">text_add_secnumbers</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-text_secnumber_suffix"><code class="xref std std-confval docutils literal notranslate"><span class="pre">text_secnumber_suffix</span></code></a></p></li>
</ul>
<p>1.7.0b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4271">#4271</a>: sphinx-build supports an option called <code class="docutils literal notranslate"><span class="pre">-j</span> <span class="pre">auto</span></code> to adjust numbers of
processes automatically.</p></li>
<li><p>Napoleon: added option to specify custom section tags.</p></li>
</ul>
</section>
<section id="id1796">
<h3>Features removed<a class="headerlink" href="#id1796" title="Link to this heading">¶</a></h3>
<p>1.7.0b1</p>
<ul class="simple">
<li><p>Configuration variables</p>
<ul>
<li><p><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_use_smartypants</span></code></p></li>
<li><p><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_keep_old_macro_names</span></code></p></li>
<li><p>latex_elements[‘footer’]</p></li>
</ul>
</li>
<li><p>utility methods of <code class="docutils literal notranslate"><span class="pre">sphinx.application.Sphinx</span></code> class</p>
<ul>
<li><p>buildername (property)</p></li>
<li><p>_display_chunk()</p></li>
<li><p>old_status_iterator()</p></li>
<li><p>status_iterator()</p></li>
<li><p>_directive_helper()</p></li>
</ul>
</li>
<li><p>utility methods of <code class="docutils literal notranslate"><span class="pre">sphinx.environment.BuildEnvironment</span></code> class</p>
<ul>
<li><p>currmodule (property)</p></li>
<li><p>currclass (property)</p></li>
</ul>
</li>
<li><p>epub2 builder</p></li>
<li><p>prefix and colorfunc parameter for warn()</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.compat</span></code> module</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.nodes.process_only_nodes()</span></code></p></li>
<li><p>LaTeX environment <code class="docutils literal notranslate"><span class="pre">notice</span></code>, use <code class="docutils literal notranslate"><span class="pre">sphinxadmonition</span></code> instead</p></li>
<li><p>LaTeX <code class="docutils literal notranslate"><span class="pre">\sphinxstylethead</span></code>, use <code class="docutils literal notranslate"><span class="pre">\sphinxstyletheadfamily</span></code></p></li>
<li><p>C++, support of function concepts. Thanks to mickk-on-cpp.</p></li>
<li><p>Not used and previously not documented LaTeX macros <code class="docutils literal notranslate"><span class="pre">\shortversion</span></code>
and <code class="docutils literal notranslate"><span class="pre">\setshortversion</span></code></p></li>
</ul>
</section>
<section id="id1797">
<h3>Bugs fixed<a class="headerlink" href="#id1797" title="Link to this heading">¶</a></h3>
<p>1.7.0b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3882">#3882</a>: Update the order of files for HTMLHelp and QTHelp</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3962">#3962</a>: sphinx-apidoc does not recognize implicit namespace packages correctly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4094">#4094</a>: C++, allow empty template argument lists.</p></li>
<li><p>C++, also hyperlink types in the name of declarations with qualified names.</p></li>
<li><p>C++, do not add index entries for declarations inside concepts.</p></li>
<li><p>C++, support the template disambiguator for dependent names.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4314">#4314</a>: For PDF ‘howto’ documents, numbering of code-blocks differs from the
one of figures and tables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4330">#4330</a>: PDF ‘howto’ documents have an incoherent default LaTeX tocdepth counter
setting</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4198">#4198</a>: autosummary emits multiple ‘autodoc-process-docstring’ event. Thanks
to Joel Nothman.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4081">#4081</a>: Warnings and errors colored the same when building</p></li>
<li><p>latex: Do not display ‘Release’ label if <a class="reference internal" href="usage/configuration.html#confval-release"><code class="xref std std-confval docutils literal notranslate"><span class="pre">release</span></code></a> is not set</p></li>
</ul>
<p>1.7.0b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4415">#4415</a>: autodoc classifies inherited classmethods as regular methods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4415">#4415</a>: autodoc classifies inherited staticmethods as regular methods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4472">#4472</a>: DOCUMENTATION_OPTIONS is not defined</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4491">#4491</a>: autodoc: prefer _MockImporter over other importers in sys.meta_path</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4490">#4490</a>: autodoc: type annotation is broken with python 3.7.0a4+</p></li>
<li><p>utils package is no longer installed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3952">#3952</a>: apidoc: module header is too escaped</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4275">#4275</a>: Formats accepted by sphinx.util.i18n.format_date are limited</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4493">#4493</a>: recommonmark raises AttributeError if AutoStructify enabled</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4209">#4209</a>: intersphinx: In link title, “v” should be optional if target has no
version</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4230">#4230</a>: slowdown in writing pages with sphinx 1.6</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4522">#4522</a>: epub: document is not rebuilt even if config changed</p></li>
</ul>
<p>1.7.0b3</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4019">#4019</a>: inheritance_diagram AttributeError stopping make process</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4531">#4531</a>: autosummary: methods are not treated as attributes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4538">#4538</a>: autodoc: <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc.Options</span></code> has been moved</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4539">#4539</a>: autodoc emits warnings for partialmethods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4223">#4223</a>: doctest: failing tests reported in wrong file, at wrong line</p></li>
<li><p>i18n: message catalogs are not compiled if specific filenames are given for
<code class="docutils literal notranslate"><span class="pre">sphinx-build</span></code> as arguments (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4560">#4560</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4027">#4027</a>: sphinx.ext.autosectionlabel now expects labels to be the same as they
are in the raw source; no smart quotes, nothig fancy.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4581">#4581</a>: apidoc: Excluded modules still included</p></li>
</ul>
</section>
<section id="id1824">
<h3>Testing<a class="headerlink" href="#id1824" title="Link to this heading">¶</a></h3>
<p>1.7.0b1</p>
<ul class="simple">
<li><p>Add support for docutils 0.14</p></li>
<li><p>Add tests for the <code class="docutils literal notranslate"><span class="pre">sphinx.ext.inheritance_diagram</span></code> extension.</p></li>
</ul>
</section>
</section>
<section id="release-1-6-7-released-feb-04-2018">
<h2>Release 1.6.7 (released Feb 04, 2018)<a class="headerlink" href="#release-1-6-7-released-feb-04-2018" title="Link to this heading">¶</a></h2>
<section id="id1825">
<h3>Bugs fixed<a class="headerlink" href="#id1825" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1922">#1922</a>: html search: Upper characters problem in French</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4412">#4412</a>: Updated jQuery version from 3.1.0 to 3.2.1</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4438">#4438</a>: math: math with labels with whitespace cause html error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2437">#2437</a>: make full reference for classes, aliased with “alias of”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4434">#4434</a>: pure numbers as link targets produce warning</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4477">#4477</a>: Build fails after building specific files</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4449">#4449</a>: apidoc: include “empty” packages that contain modules</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3917">#3917</a>: citation labels are transformed to ellipsis</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4501">#4501</a>: graphviz: epub3 validation error caused if graph is not clickable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4514">#4514</a>: graphviz: workaround for wrong map ID which graphviz generates</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4525">#4525</a>: autosectionlabel does not support parallel build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3953">#3953</a>: Do not raise warning when there is a working intersphinx inventory</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4487">#4487</a>: math: ValueError is raised on parallel build. Thanks to jschueller.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2372">#2372</a>: autosummary: invalid signatures are shown for type annotated functions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3942">#3942</a>: html: table is not aligned to center even if <code class="docutils literal notranslate"><span class="pre">:align:</span> <span class="pre">center</span></code></p></li>
</ul>
</section>
</section>
<section id="release-1-6-6-released-jan-08-2018">
<h2>Release 1.6.6 (released Jan 08, 2018)<a class="headerlink" href="#release-1-6-6-released-jan-08-2018" title="Link to this heading">¶</a></h2>
<section id="id1841">
<h3>Features added<a class="headerlink" href="#id1841" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4181">#4181</a>: autodoc: Sort dictionary keys when possible</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">VerbatimHighlightColor</span></code> is a new
<a class="reference internal" href="latex.html#latexsphinxsetup"><span class="std std-ref">LaTeX ‘sphinxsetup’</span></a> key (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4285">#4285</a>)</p></li>
<li><p>Easier customizability of LaTeX macros involved in rendering of code-blocks</p></li>
<li><p>Show traceback if conf.py raises an exception (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4369">#4369</a>)</p></li>
<li><p>Add <a class="reference internal" href="usage/configuration.html#confval-smartquotes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">smartquotes</span></code></a> to disable smart quotes through <code class="docutils literal notranslate"><span class="pre">conf.py</span></code>
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3967">#3967</a>)</p></li>
<li><p>Add <a class="reference internal" href="usage/configuration.html#confval-smartquotes_action"><code class="xref std std-confval docutils literal notranslate"><span class="pre">smartquotes_action</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-smartquotes_excludes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">smartquotes_excludes</span></code></a>
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4142">#4142</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4357">#4357</a>)</p></li>
</ul>
</section>
<section id="id1848">
<h3>Bugs fixed<a class="headerlink" href="#id1848" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4334">#4334</a>: sphinx-apidoc: Don’t generate references to non-existing files in TOC</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4206">#4206</a>: latex: reST label between paragraphs loses paragraph break</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4231">#4231</a>: html: Apply fixFirefoxAnchorBug only under Firefox</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4221">#4221</a>: napoleon depends on autodoc, but users need to load it manually</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2298">#2298</a>: automodule fails to document a class attribute</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4099">#4099</a>: C++: properly link class reference to class from inside constructor</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4267">#4267</a>: PDF build broken by Unicode U+2116 NUMERO SIGN character</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4249">#4249</a>: PDF output: Pygments error highlighting increases line spacing in
code blocks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1238">#1238</a>: Support <code class="docutils literal notranslate"><span class="pre">:emphasize-lines:</span></code> in PDF output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4279">#4279</a>: Sphinx crashes with pickling error when run with multiple processes and
remote image</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1421">#1421</a>: Respect the quiet flag in sphinx-quickstart</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4281">#4281</a>: Race conditions when creating output directory</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4315">#4315</a>: For PDF ‘howto’ documents, <code class="docutils literal notranslate"><span class="pre">latex_toplevel_sectioning='part'</span></code>
generates <code class="docutils literal notranslate"><span class="pre">\chapter</span></code> commands</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4214">#4214</a>: Two todolist directives break Sphinx 1.6.5</p></li>
<li><p>Fix links to external option docs with intersphinx (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3769">#3769</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4091">#4091</a>: Private members not documented without :undoc-members:</p></li>
</ul>
</section>
</section>
<section id="release-1-6-5-released-oct-23-2017">
<h2>Release 1.6.5 (released Oct 23, 2017)<a class="headerlink" href="#release-1-6-5-released-oct-23-2017" title="Link to this heading">¶</a></h2>
<section id="id1865">
<h3>Features added<a class="headerlink" href="#id1865" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4107">#4107</a>: Make searchtools.js compatible with pre-Sphinx1.5 templates</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4112">#4112</a>: Don’t override the smart_quotes setting if it was already set</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4125">#4125</a>: Display reference texts of original and translated passages on
i18n warning message</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4147">#4147</a>: Include the exception when logging PO/MO file read/write</p></li>
</ul>
</section>
<section id="id1870">
<h3>Bugs fixed<a class="headerlink" href="#id1870" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4085">#4085</a>: Failed PDF build from image in parsed-literal using <code class="docutils literal notranslate"><span class="pre">:align:</span></code> option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4100">#4100</a>: Remove debug print from autodoc extension</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3987">#3987</a>: Changing theme from alabaster causes HTML build to fail</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4096">#4096</a>: C++, don’t crash when using the wrong role type. Thanks to mitya57.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4070">#4070</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4111">#4111</a>: crashes when the warning message contains format strings (again)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4108">#4108</a>: Search word highlighting breaks SVG images</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3692">#3692</a>: Unable to build HTML if writing .buildinfo failed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4152">#4152</a>: HTML writer crashes if a field list is placed on top of the document</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4063">#4063</a>: Sphinx crashes when labeling directive <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">todolist::</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4134">#4134</a>: [doc] <code class="file docutils literal notranslate"><span class="pre">docutils.conf</span></code> is not documented explicitly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4169">#4169</a>: Chinese language doesn’t trigger Chinese search automatically</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1020">#1020</a>: ext.todo todolist not linking to the page in pdflatex</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3965">#3965</a>: New quickstart generates wrong SPHINXBUILD in Makefile</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3739">#3739</a>: <code class="docutils literal notranslate"><span class="pre">:module:</span></code> option is ignored at content of pyobjects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4149">#4149</a>: Documentation: Help choosing <a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4090">#4090</a>: [doc] <a class="reference internal" href="usage/configuration.html#confval-latex_additional_files"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_additional_files</span></code></a> with extra LaTeX macros should
not use <code class="docutils literal notranslate"><span class="pre">.tex</span></code> extension</p></li>
<li><p>Failed to convert reST parser error to warning (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4132">#4132</a>)</p></li>
</ul>
</section>
</section>
<section id="release-1-6-4-released-sep-26-2017">
<h2>Release 1.6.4 (released Sep 26, 2017)<a class="headerlink" href="#release-1-6-4-released-sep-26-2017" title="Link to this heading">¶</a></h2>
<section id="id1889">
<h3>Features added<a class="headerlink" href="#id1889" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3926">#3926</a>: Add <code class="docutils literal notranslate"><span class="pre">autodoc_warningiserror</span></code> to suppress the behavior of <code class="docutils literal notranslate"><span class="pre">-W</span></code>
option during importing target modules on autodoc</p></li>
</ul>
</section>
<section id="id1891">
<h3>Bugs fixed<a class="headerlink" href="#id1891" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3924">#3924</a>: docname lost after dynamically parsing RST in extension</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3946">#3946</a>: Typo in sphinx.sty (this was a bug with no effect in default context)</p></li>
<li><dl class="field-list simple">
<dt class="field-odd">pep<span class="colon">:</span></dt>
<dd class="field-odd"><p>and :rfc: does not supports <code class="docutils literal notranslate"><span class="pre">default-role</span></code> directive (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3960">#3960</a>)</p>
</dd>
</dl>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3960">#3960</a>: default_role = ‘guilabel’ not functioning</p></li>
<li><p>Missing <code class="docutils literal notranslate"><span class="pre">texinputs_win/Makefile</span></code> to be used in latexpdf builder on windows.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4026">#4026</a>: nature: Fix macOS Safari scrollbar color</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3877">#3877</a>: Fix for C++ multiline signatures.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4006">#4006</a>: Fix crash on parallel build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3969">#3969</a>: private instance attributes causes AttributeError</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4041">#4041</a>: C++, remove extra name linking in function pointers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4038">#4038</a>: C, add missing documentation of <code class="docutils literal notranslate"><span class="pre">member</span></code> role.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4044">#4044</a>: An empty multicolumn cell causes extra row height in PDF output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4049">#4049</a>: Fix typo in output of sphinx-build -h</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4062">#4062</a>: hashlib.sha1() must take bytes, not unicode on Python 3</p></li>
<li><p>Avoid indent after index entries in latex (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4066">#4066</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4070">#4070</a>: crashes when the warning message contains format strings</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4067">#4067</a>: Return non-zero exit status when make subprocess fails</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4055">#4055</a>: graphviz: the :align: option does not work for SVG output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4055">#4055</a>: graphviz: the :align: center option does not work for latex output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4051">#4051</a>: <code class="docutils literal notranslate"><span class="pre">warn()</span></code> function for HTML theme outputs ‘None’ string</p></li>
</ul>
</section>
</section>
<section id="release-1-6-3-released-jul-02-2017">
<h2>Release 1.6.3 (released Jul 02, 2017)<a class="headerlink" href="#release-1-6-3-released-jul-02-2017" title="Link to this heading">¶</a></h2>
<section id="id1911">
<h3>Features added<a class="headerlink" href="#id1911" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>latex: hint that code-block continues on next page (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3764">#3764</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3792">#3792</a>)</p></li>
</ul>
</section>
<section id="id1914">
<h3>Bugs fixed<a class="headerlink" href="#id1914" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3821">#3821</a>: Failed to import sphinx.util.compat with docutils-0.14rc1</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3829">#3829</a>: sphinx-quickstart template is incomplete regarding use of alabaster</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3772">#3772</a>: ‘str object’ has no attribute ‘filename’</p></li>
<li><p>Emit wrong warnings if citation label includes hyphens (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3565">#3565</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3858">#3858</a>: Some warnings are not colored when using –color option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3775">#3775</a>: Remove unwanted whitespace in default template</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3835">#3835</a>: sphinx.ext.imgmath fails to convert SVG images if project directory
name contains spaces</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3850">#3850</a>: Fix color handling in make mode’s help command</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3865">#3865</a>: use of self.env.warn in sphinx extension fails</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3824">#3824</a>: production lists apply smart quotes transform since Sphinx 1.6.1</p></li>
<li><p>latex: fix <code class="docutils literal notranslate"><span class="pre">\sphinxbfcode</span></code> swallows initial space of argument</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3878">#3878</a>: Quotes in auto-documented class attributes should be straight quotes
in PDF output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3881">#3881</a>: LaTeX figure floated to next page sometimes leaves extra vertical
whitespace</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3885">#3885</a>: duplicated footnotes raises IndexError</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3873">#3873</a>: Failure of deprecation warning mechanism of
<code class="docutils literal notranslate"><span class="pre">sphinx.util.compat.Directive</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3874">#3874</a>: Bogus warnings for “citation not referenced” for cross-file citations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3860">#3860</a>: Don’t download images when builders not supported images</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3860">#3860</a>: Remote image URIs without filename break builders not supported remote
images</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3833">#3833</a>: command line messages are translated unintentionally with <code class="docutils literal notranslate"><span class="pre">language</span></code>
setting.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3840">#3840</a>: make checking <code class="docutils literal notranslate"><span class="pre">epub_uid</span></code> strict</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3851">#3851</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3706">#3706</a>: Fix about box drawing characters for PDF output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3900">#3900</a>: autosummary could not find methods</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3902">#3902</a>: Emit error if <code class="docutils literal notranslate"><span class="pre">latex_documents</span></code> contains non-unicode string in py2</p></li>
</ul>
</section>
</section>
<section id="release-1-6-2-released-may-28-2017">
<h2>Release 1.6.2 (released May 28, 2017)<a class="headerlink" href="#release-1-6-2-released-may-28-2017" title="Link to this heading">¶</a></h2>
<section id="id1938">
<h3>Incompatible changes<a class="headerlink" href="#id1938" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3789">#3789</a>: Do not require typing module for python>=3.5</p></li>
</ul>
</section>
<section id="id1940">
<h3>Bugs fixed<a class="headerlink" href="#id1940" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3754">#3754</a>: HTML builder crashes if HTML theme appends own stylesheets</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3756">#3756</a>: epub: Entity ‘mdash’ not defined</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3758">#3758</a>: Sphinx crashed if logs are emitted in conf.py</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3755">#3755</a>: incorrectly warns about dedent with literalinclude</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3742">#3742</a>: <a class="reference external" href="https://readthedocs.org/">RTD</a> PDF builds of Sphinx own docs are
missing an index entry in the bookmarks and table of contents. This is
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2857">rtfd/readthedocs.org`#2857</a>
<<a class="reference external" href="https://github.com/rtfd/readthedocs.org/issues/2857">https://github.com/rtfd/readthedocs.org/issues/2857</a>>`_ issue, a workaround
is obtained using some extra LaTeX code in Sphinx’s own <code class="file docutils literal notranslate"><span class="pre">conf.py</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3770">#3770</a>: Build fails when a “code-block” has the option emphasize-lines and the
number indicated is higher than the number of lines</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3774">#3774</a>: Incremental HTML building broken when using citations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3763">#3763</a>: got epubcheck validations error if epub_cover is set</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3779">#3779</a>: ‘ImportError’ in sphinx.ext.autodoc due to broken ‘sys.meta_path’.
Thanks to Tatiana Tereshchenko.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3796">#3796</a>: env.resolve_references() crashes when non-document node given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3803">#3803</a>: Sphinx crashes with invalid PO files</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3791">#3791</a>: PDF “continued on next page” for long tables isn’t internationalized</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3788">#3788</a>: smartquotes emits warnings for unsupported languages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3807">#3807</a>: latex Makefile for <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">latexpdf</span></code> is only for unixen</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3781">#3781</a>: double hyphens in option directive are compiled as endashes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3817">#3817</a>: latex builder raises AttributeError</p></li>
</ul>
</section>
</section>
<section id="release-1-6-1-released-may-16-2017">
<h2>Release 1.6.1 (released May 16, 2017)<a class="headerlink" href="#release-1-6-1-released-may-16-2017" title="Link to this heading">¶</a></h2>
<section id="id1957">
<h3>Dependencies<a class="headerlink" href="#id1957" title="Link to this heading">¶</a></h3>
<p>1.6b1</p>
<ul class="simple">
<li><p>(updated) latex output is tested with Ubuntu trusty’s texlive packages (Feb.
2014) and earlier tex installations may not be fully compliant, particularly
regarding Unicode engines xelatex and lualatex</p></li>
<li><p>(added) latexmk is required for <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">latexpdf</span></code> on GNU/Linux and Mac OS X
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3082">#3082</a>)</p></li>
</ul>
</section>
<section id="id1959">
<h3>Incompatible changes<a class="headerlink" href="#id1959" title="Link to this heading">¶</a></h3>
<p>1.6b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1061">#1061</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2336">#2336</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3235">#3235</a>: Now generation of autosummary doesn’t contain imported
members by default. Thanks to Luc Saffre.</p></li>
<li><p>LaTeX <code class="docutils literal notranslate"><span class="pre">\includegraphics</span></code> command isn’t overloaded: only
<code class="docutils literal notranslate"><span class="pre">\sphinxincludegraphics</span></code> has the custom code to fit image to available width
if oversized.</p></li>
<li><p>The subclasses of <code class="docutils literal notranslate"><span class="pre">sphinx.domains.Index</span></code> should override <code class="docutils literal notranslate"><span class="pre">generate()</span></code>
method. The default implementation raises NotImplementedError</p></li>
<li><p>LaTeX positioned long tables horizontally centered, and short ones
flushed left (no text flow around table.) The position now defaults to center
in both cases, and it will obey Docutils 0.13 <code class="docutils literal notranslate"><span class="pre">:align:</span></code> option (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3415">#3415</a>,
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3377">#3377</a>)</p></li>
<li><p>option directive also allows all punctuations for the option name (refs:
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3366">#3366</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3413">#3413</a>: if <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a>’s <code class="docutils literal notranslate"><span class="pre">:start-after:</span></code> is used, make
<code class="docutils literal notranslate"><span class="pre">:lines:</span></code> relative (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3412">#3412</a>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> directive does not allow the combination of <code class="docutils literal notranslate"><span class="pre">:diff:</span></code>
option and other options (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3416">#3416</a>)</p></li>
<li><p>LuaLaTeX engine uses <code class="docutils literal notranslate"><span class="pre">fontspec</span></code> like XeLaTeX. It is advised <code class="docutils literal notranslate"><span class="pre">latex_engine</span>
<span class="pre">=</span> <span class="pre">'lualatex'</span></code> be used only on up-to-date TeX installs (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3070">#3070</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3466">#3466</a>)</p></li>
<li><p><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_keep_old_macro_names</span></code> default value has been changed from
<code class="docutils literal notranslate"><span class="pre">True</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>. This means that some LaTeX macros for styling are
by default defined only with <code class="docutils literal notranslate"><span class="pre">\sphinx..</span></code> prefixed names. (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3429">#3429</a>)</p></li>
<li><p>Footer “Continued on next page” of LaTeX longtable’s now not framed (refs:
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3497">#3497</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3529">#3529</a>: The arguments of <code class="docutils literal notranslate"><span class="pre">BuildEnvironment.__init__</span></code> is changed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3082">#3082</a>: Use latexmk for pdf (and dvi) targets (Unix-like platforms only)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3558">#3558</a>: Emit warnings if footnotes and citations are not referenced. The
warnings can be suppressed by <code class="docutils literal notranslate"><span class="pre">suppress_warnings</span></code>.</p></li>
<li><p>latex made available (non documented) colour macros from a file distributed
with pdftex engine for Plain TeX. This is removed in order to provide better
support for multiple TeX engines. Only interface from <code class="docutils literal notranslate"><span class="pre">color</span></code> or
<code class="docutils literal notranslate"><span class="pre">xcolor</span></code> packages should be used by extensions of Sphinx latex writer.
(refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3550">#3550</a>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Builder.env</span></code> is not filled at instantiation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3594">#3594</a>: LaTeX: single raw directive has been considered as block level element</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3639">#3639</a>: If <code class="docutils literal notranslate"><span class="pre">html_experimental_html5_writer</span></code> is available, epub builder use it
by default.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Sphinx.add_source_parser()</span></code> raises an error if duplicated</p></li>
</ul>
<p>1.6b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3345">#3345</a>: Replace the custom smartypants code with Docutils’ smart_quotes.
Thanks to Dmitry Shachnev, and to Günter Milde at Docutils.</p></li>
</ul>
<p>1.6b3</p>
<ul class="simple">
<li><p>LaTeX package <code class="docutils literal notranslate"><span class="pre">eqparbox</span></code> is not used and not loaded by Sphinx anymore</p></li>
<li><p>LaTeX package <code class="docutils literal notranslate"><span class="pre">multirow</span></code> is not used and not loaded by Sphinx anymore</p></li>
<li><p>Add line numbers to citation data in std domain</p></li>
</ul>
<p>1.6 final</p>
<ul class="simple">
<li><p>LaTeX package <code class="docutils literal notranslate"><span class="pre">threeparttable</span></code> is not used and not loaded by Sphinx
anymore (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3686">#3686</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3532">#3532</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3377">#3377</a>)</p></li>
</ul>
</section>
<section id="id1983">
<h3>Features removed<a class="headerlink" href="#id1983" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Configuration variables</p>
<ul>
<li><p>epub3_contributor</p></li>
<li><p>epub3_description</p></li>
<li><p>epub3_page_progression_direction</p></li>
<li><p>html_translator_class</p></li>
<li><p>html_use_modindex</p></li>
<li><p>latex_font_size</p></li>
<li><p>latex_paper_size</p></li>
<li><p>latex_preamble</p></li>
<li><p>latex_use_modindex</p></li>
<li><p>latex_use_parts</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">termsep</span></code> node</p></li>
<li><p>defindex.html template</p></li>
<li><p>LDML format support in <code class="docutils literal notranslate"><span class="pre">today</span></code>, <code class="docutils literal notranslate"><span class="pre">today_fmt</span></code> and <code class="docutils literal notranslate"><span class="pre">html_last_updated_fmt</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">:inline:</span></code> option for the directives of sphinx.ext.graphviz extension</p></li>
<li><p>sphinx.ext.pngmath extension</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.compat.make_admonition()</span></code></p></li>
</ul>
</section>
<section id="id1984">
<h3>Features added<a class="headerlink" href="#id1984" title="Link to this heading">¶</a></h3>
<p>1.6b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3136">#3136</a>: Add <code class="docutils literal notranslate"><span class="pre">:name:</span></code> option to the directives in <code class="docutils literal notranslate"><span class="pre">sphinx.ext.graphviz</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2336">#2336</a>: Add <code class="docutils literal notranslate"><span class="pre">imported_members</span></code> option to <code class="docutils literal notranslate"><span class="pre">sphinx-autogen</span></code> command to
document imported members.</p></li>
<li><p>C++, add <code class="docutils literal notranslate"><span class="pre">:tparam-line-spec:</span></code> option to templated declarations.
When specified, each template parameter will be rendered on a separate line.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3359">#3359</a>: Allow sphinx.js in a user locale dir to override sphinx.js from Sphinx</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3303">#3303</a>: Add <code class="docutils literal notranslate"><span class="pre">:pyversion:</span></code> option to the doctest directive.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3378">#3378</a>: (latex) support for <code class="docutils literal notranslate"><span class="pre">:widths:</span></code> option of table directives
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3379">#3379</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3381">#3381</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3402">#3402</a>: Allow to suppress “download file not readable” warnings using
<a class="reference internal" href="usage/configuration.html#confval-suppress_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">suppress_warnings</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3377">#3377</a>: latex: Add support for Docutils 0.13 <code class="docutils literal notranslate"><span class="pre">:align:</span></code> option for tables
(but does not implement text flow around table).</p></li>
<li><p>latex: footnotes from inside tables are hyperlinked (except from captions or
headers) (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3422">#3422</a>)</p></li>
<li><p>Emit warning if over dedent has detected on <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> directive
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3416">#3416</a>)</p></li>
<li><p>Use for LuaLaTeX same default settings as for XeLaTeX (i.e. <code class="docutils literal notranslate"><span class="pre">fontspec</span></code> and
<code class="docutils literal notranslate"><span class="pre">polyglossia</span></code>). (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3070">#3070</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3466">#3466</a>)</p></li>
<li><p>Make <code class="docutils literal notranslate"><span class="pre">'extraclassoptions'</span></code> key of <code class="docutils literal notranslate"><span class="pre">latex_elements</span></code> public (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3480">#3480</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3463">#3463</a>: Add warning messages for required EPUB3 metadata. Add default value to
<code class="docutils literal notranslate"><span class="pre">epub_description</span></code> to avoid warning like other settings.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3476">#3476</a>: setuptools: Support multiple builders</p></li>
<li><p>latex: merged cells in LaTeX tables allow code-blocks, lists, blockquotes…
as do normal cells (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3435">#3435</a>)</p></li>
<li><p>HTML builder uses experimental HTML5 writer if
<code class="docutils literal notranslate"><span class="pre">html_experimental_html5_writer</span></code> is True and docutils 0.13 or later is
installed.</p></li>
<li><p>LaTeX macros to customize space before and after tables in PDF output (refs
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3504">#3504</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3348">#3348</a>: Show decorators in literalinclude and viewcode directives</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3108">#3108</a>: Show warning if :start-at: and other literalinclude options does not
match to the text</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3609">#3609</a>: Allow to suppress “duplicate citation” warnings using
<code class="docutils literal notranslate"><span class="pre">suppress_warnings</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2803">#2803</a>: Discovery of builders by entry point</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1764">#1764</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1676">#1676</a>: Allow setting ‘rel’ and ‘title’ attributes for stylesheets</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3589">#3589</a>: Support remote images on non-HTML builders</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3589">#3589</a>: Support images in Data URI on non-HTML builders</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2961">#2961</a>: improve <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_mock_imports"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_mock_imports</span></code></a>. Now the config value only
requires to declare the top-level modules that should be mocked.
Thanks to Robin Jarry.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3449">#3449</a>: On py3, autodoc use inspect.signature for more accurate signature
calculation. Thanks to Nathaniel J. Smith.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3641">#3641</a>: Epub theme supports HTML structures that are generated by HTML5 writer.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3644">#3644</a> autodoc uses inspect instead of checking types. Thanks to
Jeroen Demeyer.</p></li>
<li><p>Add a new extension; <code class="docutils literal notranslate"><span class="pre">sphinx.ext.imgconverter</span></code>. It converts images in the
document to appropriate format for builders</p></li>
<li><p>latex: Use templates to render tables (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3389">#3389</a>, 2a37b0e)</p></li>
</ul>
<p>1.6b2</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">LATEXMKOPTS</span></code> variable for the Makefile in <code class="docutils literal notranslate"><span class="pre">$BUILDDIR/latex</span></code> to pass
options to <code class="docutils literal notranslate"><span class="pre">latexmk</span></code> when executing <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">latexpdf</span></code> (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3695">#3695</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3720">#3720</a>)</p></li>
<li><p>Add a new event <a class="reference internal" href="extdev/appapi.html#event-env-check-consistency"><code class="xref any std std-event docutils literal notranslate"><span class="pre">env-check-consistency</span></code></a> to check consistency to extensions</p></li>
<li><p>Add <a class="reference internal" href="extdev/domainapi.html#sphinx.domains.Domain.check_consistency" title="sphinx.domains.Domain.check_consistency"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">Domain.check_consistency()</span></code></a> to check consistency</p></li>
</ul>
</section>
<section id="id2018">
<h3>Bugs fixed<a class="headerlink" href="#id2018" title="Link to this heading">¶</a></h3>
<p>1.6b1</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> directive expands tabs after dedent-ing (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3416">#3416</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1574">#1574</a>: Paragraphs in table cell doesn’t work in Latex output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3288">#3288</a>: Table with merged headers not wrapping text</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3491">#3491</a>: Inconsistent vertical space around table and longtable in PDF</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3506">#3506</a>: Depart functions for all admonitions in HTML writer now properly pass
<code class="docutils literal notranslate"><span class="pre">node</span></code> to <code class="docutils literal notranslate"><span class="pre">depart_admonition</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2693">#2693</a>: Sphinx latex style file wrongly inhibits colours for section headings
for latex+dvi(ps,pdf,pdfmx)</p></li>
<li><p>C++, properly look up <code class="docutils literal notranslate"><span class="pre">any</span></code> references.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3624">#3624</a>: sphinx.ext.intersphinx couldn’t load inventories compressed with gzip</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3551">#3551</a>: PDF information dictionary is lacking author and title data</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3351">#3351</a>: intersphinx does not refers context like <code class="docutils literal notranslate"><span class="pre">py:module</span></code>, <code class="docutils literal notranslate"><span class="pre">py:class</span></code>
and so on.</p></li>
<li><p>Fail to load template file if the parent template is archived</p></li>
</ul>
<p>1.6b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3661">#3661</a>: sphinx-build crashes on parallel build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3669">#3669</a>: gettext builder fails with “ValueError: substring not found”</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3660">#3660</a>: Sphinx always depends on sphinxcontrib-websupport and its dependencies</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3472">#3472</a>: smart quotes getting wrong in latex (at least with list of strings via
autoattribute) (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3345">#3345</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3666">#3666</a>)</p></li>
</ul>
<p>1.6b3</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3588">#3588</a>: No compact (p tag) html output in the i18n document build even when
<a class="reference internal" href="usage/configuration.html#confval-html_compact_lists"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_compact_lists</span></code></a> is True.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">latexpdf</span></code> from 1.6b1 (for GNU/Linux and Mac OS, using
<code class="docutils literal notranslate"><span class="pre">latexmk</span></code>) aborted earlier in case of LaTeX errors than was the case with
1.5 series, due to hard-coded usage of <code class="docutils literal notranslate"><span class="pre">--halt-on-error</span></code> option (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3695">#3695</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3683">#3683</a>: sphinx.websupport module is not provided by default</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3683">#3683</a>: Failed to build document if builder.css_file.insert() is called</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3714">#3714</a>: viewcode extension not taking <code class="docutils literal notranslate"><span class="pre">highlight_code='none'</span></code> in account</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3698">#3698</a>: Moving :doc: to std domain broke backwards compatibility</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3633">#3633</a>: misdetect unreferenced citations</p></li>
</ul>
<p>1.6 final</p>
<ul class="simple">
<li><p>LaTeX tables do not allow multiple paragraphs in a header cell</p></li>
<li><p>LATEXOPTS is not passed over correctly to pdflatex since 1.6b3</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3532">#3532</a>: Figure or literal block captions in cells of short tables cause havoc
in PDF output</p></li>
<li><p>Fix: in PDF captions of tables are rendered differently whether table is of
longtable class or not (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3686">#3686</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3725">#3725</a>: Todo looks different from note in LaTeX output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3479">#3479</a>: stub-columns have no effect in LaTeX output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3738">#3738</a>: Nonsensical code in theming.py</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3746">#3746</a>: PDF builds fail with latexmk 4.48 or earlier due to undefined
options <code class="docutils literal notranslate"><span class="pre">-pdfxe</span></code> and <code class="docutils literal notranslate"><span class="pre">-pdflua</span></code></p></li>
</ul>
</section>
<section id="id2047">
<h3>Deprecated<a class="headerlink" href="#id2047" title="Link to this heading">¶</a></h3>
<p>1.6b1</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.compat.Directive</span></code> class is now deprecated. Please use instead
<code class="docutils literal notranslate"><span class="pre">docutils.parsers.rst.Directive</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.compat.docutils_version</span></code> is now deprecated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2367">#2367</a>: <code class="docutils literal notranslate"><span class="pre">Sphinx.warn()</span></code>, <code class="docutils literal notranslate"><span class="pre">Sphinx.info()</span></code> and other logging methods are now
deprecated. Please use <code class="docutils literal notranslate"><span class="pre">sphinx.util.logging</span></code> (<a class="reference internal" href="extdev/logging.html#logging-api"><span class="std std-ref">Logging API</span></a>) instead.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3318">#3318</a>: <code class="docutils literal notranslate"><span class="pre">notice</span></code> is now deprecated as LaTeX environment name and will be
removed at Sphinx 1.7. Extension authors please use <code class="docutils literal notranslate"><span class="pre">sphinxadmonition</span></code>
instead (as Sphinx does since 1.5.)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Sphinx.status_iterator()</span></code> and <code class="docutils literal notranslate"><span class="pre">Sphinx.old_status_iterator()</span></code> is now
deprecated. Please use <code class="docutils literal notranslate"><span class="pre">sphinx.util:status_iterator()</span></code> instead.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Sphinx._directive_helper()</span></code> is deprecated. Please use
<code class="docutils literal notranslate"><span class="pre">sphinx.util.docutils.directive_helper()</span></code> instead.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BuildEnvironment.set_warnfunc()</span></code> is now deprecated</p></li>
<li><p>Following methods of <code class="docutils literal notranslate"><span class="pre">BuildEnvironment</span></code> is now deprecated.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">BuildEnvironment.note_toctree()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BuildEnvironment.get_toc_for()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BuildEnvironment.get_toctree_for()</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BuildEnvironment.create_index()</span></code></p></li>
</ul>
<p>Please use <code class="docutils literal notranslate"><span class="pre">sphinx.environment.adapters</span></code> modules instead.</p>
</li>
<li><p>latex package <code class="docutils literal notranslate"><span class="pre">footnote</span></code> is not loaded anymore by its bundled replacement
<code class="docutils literal notranslate"><span class="pre">footnotehyper-sphinx</span></code>. The redefined macros keep the same names as in the
original package.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3429">#3429</a>: deprecate config setting <code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_keep_old_macro_names</span></code>. It will
be removed at 1.7, and already its default value has changed from <code class="docutils literal notranslate"><span class="pre">True</span></code> to
<code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3221">#3221</a>: epub2 builder is deprecated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3254">#3254</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.websupport</span></code> is now separated into independent package;
<code class="docutils literal notranslate"><span class="pre">sphinxcontrib-websupport</span></code>. <code class="docutils literal notranslate"><span class="pre">sphinx.websupport</span></code> will be removed in
Sphinx 2.0.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3628">#3628</a>: <code class="docutils literal notranslate"><span class="pre">sphinx_themes</span></code> entry_point is deprecated. Please use
<code class="docutils literal notranslate"><span class="pre">sphinx.html_themes</span></code> instead.</p></li>
</ul>
<p>1.6b2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3662">#3662</a>: <code class="docutils literal notranslate"><span class="pre">builder.css_files</span></code> is deprecated. Please use <code class="docutils literal notranslate"><span class="pre">add_stylesheet()</span></code>
API instead.</p></li>
</ul>
<p>1.6 final</p>
<ul class="simple">
<li><p>LaTeX <code class="docutils literal notranslate"><span class="pre">\sphinxstylethead</span></code> is deprecated at 1.6 and will be removed at 1.7.
Please move customization into new macro <code class="docutils literal notranslate"><span class="pre">\sphinxstyletheadfamily</span></code>.</p></li>
</ul>
</section>
<section id="id2055">
<h3>Testing<a class="headerlink" href="#id2055" title="Link to this heading">¶</a></h3>
<p>1.6 final</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3458">#3458</a>: Add <code class="docutils literal notranslate"><span class="pre">sphinx.testing</span></code> (experimental)</p></li>
</ul>
</section>
</section>
<section id="release-1-6-unreleased">
<h2>Release 1.6 (unreleased)<a class="headerlink" href="#release-1-6-unreleased" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>not released (because of package script error)</p></li>
</ul>
</section>
<section id="release-1-5-6-released-may-15-2017">
<h2>Release 1.5.6 (released May 15, 2017)<a class="headerlink" href="#release-1-5-6-released-may-15-2017" title="Link to this heading">¶</a></h2>
<section id="id2057">
<h3>Bugs fixed<a class="headerlink" href="#id2057" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3614">#3614</a>: Sphinx crashes with requests-2.5.0</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3618">#3618</a>: autodoc crashes with tupled arguments</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3664">#3664</a>: No space after the bullet in items of a latex list produced by Sphinx</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3657">#3657</a>: EPUB builder crashes if a document starting with genindex exists</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3588">#3588</a>: No compact (p tag) html output in the i18n document build even when
<a class="reference internal" href="usage/configuration.html#confval-html_compact_lists"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_compact_lists</span></code></a> is True.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3685">#3685</a>: AttributeError when using 3rd party domains</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3702">#3702</a>: LaTeX writer styles figure legends with a hard-coded <code class="docutils literal notranslate"><span class="pre">\small</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3708">#3708</a>: LaTeX writer allows irc scheme</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3717">#3717</a>: Stop enforcing that favicon’s must be .ico</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3731">#3731</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3732">#3732</a>: Protect isenumclass predicate against non-class arguments</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3320">#3320</a>: Warning about reference target not being found for container types</p></li>
<li><p>Misspelled ARCHIVEPREFIX in Makefile for latex build repertory</p></li>
</ul>
</section>
</section>
<section id="release-1-5-5-released-apr-03-2017">
<h2>Release 1.5.5 (released Apr 03, 2017)<a class="headerlink" href="#release-1-5-5-released-apr-03-2017" title="Link to this heading">¶</a></h2>
<section id="id2070">
<h3>Bugs fixed<a class="headerlink" href="#id2070" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3597">#3597</a>: python domain raises UnboundLocalError if invalid name given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3599">#3599</a>: Move to new MathJax CDN</p></li>
</ul>
</section>
</section>
<section id="release-1-5-4-released-apr-02-2017">
<h2>Release 1.5.4 (released Apr 02, 2017)<a class="headerlink" href="#release-1-5-4-released-apr-02-2017" title="Link to this heading">¶</a></h2>
<section id="id2073">
<h3>Features added<a class="headerlink" href="#id2073" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3470">#3470</a>: Make genindex support all kinds of letters, not only Latin ones</p></li>
</ul>
</section>
<section id="id2075">
<h3>Bugs fixed<a class="headerlink" href="#id2075" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3445">#3445</a>: setting <code class="docutils literal notranslate"><span class="pre">'inputenc'</span></code> key to <code class="docutils literal notranslate"><span class="pre">\\usepackage[utf8x]{inputenc}</span></code> leads
to failed PDF build</p></li>
<li><p>EPUB file has duplicated <code class="docutils literal notranslate"><span class="pre">nav.xhtml</span></code> link in <code class="docutils literal notranslate"><span class="pre">content.opf</span></code>
except first time build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3488">#3488</a>: objects.inv has broken when <code class="docutils literal notranslate"><span class="pre">release</span></code> or <code class="docutils literal notranslate"><span class="pre">version</span></code> contain
return code</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2073">#2073</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3443">#3443</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3490">#3490</a>: gettext builder that writes pot files unless the content
are same without creation date. Thanks to Yoshiki Shibukawa.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3487">#3487</a>: intersphinx: failed to refer options</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3496">#3496</a>: latex longtable’s last column may be much wider than its contents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3507">#3507</a>: wrong quotes in latex output for productionlist directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3533">#3533</a>: Moving from Sphinx 1.3.1 to 1.5.3 breaks LaTeX compilation of links
rendered as code</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2665">#2665</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2607">#2607</a>: Link names in C++ docfields, and make it possible for other
domains.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3542">#3542</a>: C++, fix parsing error of non-type template argument with template.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3065">#3065</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3520">#3520</a>: python domain fails to recognize nested class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3575">#3575</a>: Problems with pdflatex in a Turkish document built with sphinx has
reappeared (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2997">#2997</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2397">#2397</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3577">#3577</a>: Fix intersphinx debug tool</p></li>
<li><p>A LaTeX command such as <code class="docutils literal notranslate"><span class="pre">\\large</span></code> inserted in the title items of
<a class="reference internal" href="usage/configuration.html#confval-latex_documents"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_documents</span></code></a> causes failed PDF build (refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3551">#3551</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3567">#3567</a>)</p></li>
</ul>
</section>
</section>
<section id="release-1-5-3-released-feb-26-2017">
<h2>Release 1.5.3 (released Feb 26, 2017)<a class="headerlink" href="#release-1-5-3-released-feb-26-2017" title="Link to this heading">¶</a></h2>
<section id="id2096">
<h3>Features added<a class="headerlink" href="#id2096" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Support requests-2.0.0 (experimental) (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3367">#3367</a>)</p></li>
<li><p>(latex) PDF page margin dimensions may be customized (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3387">#3387</a>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> directive allows combination of <code class="docutils literal notranslate"><span class="pre">:pyobject:</span></code> and
<code class="docutils literal notranslate"><span class="pre">:lines:</span></code> options (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3416">#3416</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3400">#3400</a>: make-mode doesn’t use subprocess on building docs</p></li>
</ul>
</section>
<section id="id2101">
<h3>Bugs fixed<a class="headerlink" href="#id2101" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3370">#3370</a>: the caption of code-block is not picked up for translation</p></li>
<li><p>LaTeX: <a class="reference internal" href="usage/configuration.html#confval-release"><code class="xref std std-confval docutils literal notranslate"><span class="pre">release</span></code></a> is not escaped (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3362">#3362</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3364">#3364</a>: sphinx-quickstart prompts overflow on Console with 80 chars width</p></li>
<li><p>since 1.5, PDF’s TOC and bookmarks lack an entry for general Index
(refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3383">#3383</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3392">#3392</a>: <code class="docutils literal notranslate"><span class="pre">'releasename'</span></code> in <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a> is not working</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3356">#3356</a>: Page layout for Japanese <code class="docutils literal notranslate"><span class="pre">'manual'</span></code> docclass has a shorter text area</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3394">#3394</a>: When <code class="docutils literal notranslate"><span class="pre">'pointsize'</span></code> is not <code class="docutils literal notranslate"><span class="pre">10pt</span></code>, Japanese <code class="docutils literal notranslate"><span class="pre">'manual'</span></code> document
gets wrong PDF page dimensions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3399">#3399</a>: quickstart: conf.py was not overwritten by template</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3366">#3366</a>: option directive does not allow punctuations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3410">#3410</a>: return code in <a class="reference internal" href="usage/configuration.html#confval-release"><code class="xref std std-confval docutils literal notranslate"><span class="pre">release</span></code></a> breaks html search</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3427">#3427</a>: autodoc: memory addresses are not stripped on Windows</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3428">#3428</a>: xetex build tests fail due to fontspec v2.6 defining <code class="docutils literal notranslate"><span class="pre">\strong</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3349">#3349</a>: Result of <code class="docutils literal notranslate"><span class="pre">IndexBuilder.load()</span></code> is broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3450">#3450</a>: &nbsp is appeared in EPUB docs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3418">#3418</a>: Search button is misaligned in nature and pyramid theme</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3421">#3421</a>: Could not translate a caption of tables</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3552">#3552</a>: linkcheck raises UnboundLocalError</p></li>
</ul>
</section>
</section>
<section id="release-1-5-2-released-jan-22-2017">
<h2>Release 1.5.2 (released Jan 22, 2017)<a class="headerlink" href="#release-1-5-2-released-jan-22-2017" title="Link to this heading">¶</a></h2>
<section id="id2119">
<h3>Incompatible changes<a class="headerlink" href="#id2119" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Dependency requirement updates: requests 2.4.0 or above (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3268">#3268</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3310">#3310</a>)</p></li>
</ul>
</section>
<section id="id2122">
<h3>Features added<a class="headerlink" href="#id2122" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3241">#3241</a>: emit latex warning if buggy titlesec (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3210">#3210</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3194">#3194</a>: Refer the $MAKE environment variable to determine <code class="docutils literal notranslate"><span class="pre">make</span></code> command</p></li>
<li><p>Emit warning for nested numbered toctrees (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3142">#3142</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/978">#978</a>: <a class="reference internal" href="usage/extensions/intersphinx.html#confval-intersphinx_mapping"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">intersphinx_mapping</span></code></a> also allows a list as a parameter</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3340">#3340</a>: (LaTeX) long lines in <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#parsed-literal">parsed-literal</a> are wrapped like in
<a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a>, inline math and footnotes are fully functional.</p></li>
</ul>
</section>
<section id="id2129">
<h3>Bugs fixed<a class="headerlink" href="#id2129" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3246">#3246</a>: xapian search adapter crashes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3253">#3253</a>: In Py2 environment, building another locale with a non-captioned
toctree produces <code class="docutils literal notranslate"><span class="pre">None</span></code> captions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/185">#185</a>: References to section title including raw node has broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3255">#3255</a>: In Py3.4 environment, autodoc doesn’t support documentation for
attributes of Enum class correctly.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3261">#3261</a>: <code class="docutils literal notranslate"><span class="pre">latex_use_parts</span></code> makes sphinx crash</p></li>
<li><p>The warning type <code class="docutils literal notranslate"><span class="pre">misc.highlighting_failure</span></code> does not work</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3294">#3294</a>: <code class="docutils literal notranslate"><span class="pre">add_latex_package()</span></code> make crashes non-LaTeX builders</p></li>
<li><p>The caption of table are rendered as invalid HTML (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3287">#3287</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3268">#3268</a>: Sphinx crashes with requests package from Debian jessie</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3284">#3284</a>: Sphinx crashes on parallel build with an extension which raises
unserializable exception</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3315">#3315</a>: Bibliography crashes on latex build with docclass ‘memoir’</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3328">#3328</a>: Could not refer rubric implicitly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3329">#3329</a>: emit warnings if po file is invalid and can’t read it. Also writing mo</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3337">#3337</a>: Ugly rendering of definition list term’s classifier</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3335">#3335</a>: gettext does not extract field_name of a field in a field_list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2952">#2952</a>: C++, fix refs to operator() functions.</p></li>
<li><p>Fix Unicode super- and subscript digits in <a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a> and
parsed-literal LaTeX output (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3342">#3342</a>)</p></li>
<li><p>LaTeX writer: leave <code class="docutils literal notranslate"><span class="pre">"</span></code> character inside parsed-literal as is (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3341">#3341</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3234">#3234</a>: intersphinx failed for encoded inventories</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3158">#3158</a>: too much space after captions in PDF output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3317">#3317</a>: An URL in parsed-literal contents gets wrongly rendered in PDF if
with hyphen</p></li>
<li><p>LaTeX crash if the filename of an image inserted in parsed-literal
via a substitution contains an hyphen (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3340">#3340</a>)</p></li>
<li><p>LaTeX rendering of inserted footnotes in parsed-literal is wrong (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3340">#3340</a>)</p></li>
<li><p>Inline math in parsed-literal is not rendered well by LaTeX (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3340">#3340</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3308">#3308</a>: Parsed-literals don’t wrap very long lines with pdf builder (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3340">#3340</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3295">#3295</a>: Could not import extension sphinx.builders.linkcheck</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3285">#3285</a>: autosummary: asterisks are escaped twice</p></li>
<li><p>LaTeX, pass dvipdfm option to geometry package for Japanese documents (ref
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3363">#3363</a>)</p></li>
<li><p>Fix parselinenos() could not parse left half open range (cf. “-4”)</p></li>
</ul>
</section>
</section>
<section id="release-1-5-1-released-dec-13-2016">
<h2>Release 1.5.1 (released Dec 13, 2016)<a class="headerlink" href="#release-1-5-1-released-dec-13-2016" title="Link to this heading">¶</a></h2>
<section id="id2158">
<h3>Features added<a class="headerlink" href="#id2158" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3214">#3214</a>: Allow to suppress “unknown mimetype” warnings from epub builder using
<a class="reference internal" href="usage/configuration.html#confval-suppress_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">suppress_warnings</span></code></a>.</p></li>
</ul>
</section>
<section id="id2160">
<h3>Bugs fixed<a class="headerlink" href="#id2160" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3195">#3195</a>: Can not build in parallel</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3198">#3198</a>: AttributeError is raised when toctree has ‘self’</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3211">#3211</a>: Remove untranslated sphinx locale catalogs (it was covered by
untranslated it_IT)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3212">#3212</a>: HTML Builders crashes with docutils-0.13</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3207">#3207</a>: more latex problems with references inside parsed-literal directive
(<code class="docutils literal notranslate"><span class="pre">\DUrole</span></code>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3205">#3205</a>: sphinx.util.requests crashes with old pyOpenSSL (< 0.14)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3220">#3220</a>: KeyError when having a duplicate citation</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3200">#3200</a>: LaTeX: xref inside desc_name not allowed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3228">#3228</a>: <code class="docutils literal notranslate"><span class="pre">build_sphinx</span></code> command crashes when missing dependency</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2469">#2469</a>: Ignore updates of catalog files for gettext builder. Thanks to
Hiroshi Ohkubo.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3183">#3183</a>: Randomized jump box order in generated index page.</p></li>
</ul>
</section>
</section>
<section id="release-1-5-released-dec-5-2016">
<h2>Release 1.5 (released Dec 5, 2016)<a class="headerlink" href="#release-1-5-released-dec-5-2016" title="Link to this heading">¶</a></h2>
<section id="id2172">
<h3>Incompatible changes<a class="headerlink" href="#id2172" title="Link to this heading">¶</a></h3>
<p>1.5a1</p>
<ul class="simple">
<li><p>latex, package fancybox is not any longer a dependency of sphinx.sty</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">'locales'</span></code> as a default value of <a class="reference internal" href="usage/configuration.html#confval-locale_dirs"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">locale_dirs</span></code></a></p></li>
<li><p>latex, package ifthen is not any longer a dependency of sphinx.sty</p></li>
<li><p>latex, style file does not modify fancyvrb’s Verbatim (also available as
OriginalVerbatim) but uses sphinxVerbatim for name of custom wrapper.</p></li>
<li><p>latex, package newfloat is not used (and not included) anymore (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2660">#2660</a>;
it was used since 1.3.4 and shipped with Sphinx since 1.4).</p></li>
<li><p>latex, literal blocks in tables do not use OriginalVerbatim but
sphinxVerbatimintable which handles captions and wraps lines (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2704">#2704</a>).</p></li>
<li><p>latex, replace <code class="docutils literal notranslate"><span class="pre">pt</span></code> by TeX equivalent <code class="docutils literal notranslate"><span class="pre">bp</span></code> if found in <code class="docutils literal notranslate"><span class="pre">width</span></code> or
<code class="docutils literal notranslate"><span class="pre">height</span></code> attribute of an image.</p></li>
<li><p>latex, if <code class="docutils literal notranslate"><span class="pre">width</span></code> or <code class="docutils literal notranslate"><span class="pre">height</span></code> attribute of an image is given with no unit,
use <code class="docutils literal notranslate"><span class="pre">px</span></code> rather than ignore it.</p></li>
<li><p>latex: Separate stylesheets of pygments to independent .sty file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2454">#2454</a>: The filename of sourcelink is now changed. The value of
<a class="reference internal" href="usage/configuration.html#confval-html_sourcelink_suffix"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_sourcelink_suffix</span></code></a> will be appended to the original filename (like
<code class="docutils literal notranslate"><span class="pre">index.rst.txt</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.copy_static_entry()</span></code> is now deprecated.
Use <code class="docutils literal notranslate"><span class="pre">sphinx.util.fileutil.copy_asset()</span></code> instead.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.osutil.filecopy()</span></code> skips copying if the file has not been
changed (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2510">#2510</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2753">#2753</a>)</p></li>
<li><p>Internet Explorer 6-8, Opera 12.1x or Safari 5.1+ support is dropped
because jQuery version is updated from 1.11.0 to 3.1.0 (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2634">#2634</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2773">#2773</a>)</p></li>
<li><p>QtHelpBuilder doesn’t generate search page (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2352">#2352</a>)</p></li>
<li><p>QtHelpBuilder uses <code class="docutils literal notranslate"><span class="pre">nonav</span></code> theme instead of default one
to improve readability.</p></li>
<li><p>latex: To provide good default settings to Japanese documents, Sphinx uses
<code class="docutils literal notranslate"><span class="pre">jreport</span></code> and <code class="docutils literal notranslate"><span class="pre">jsbook</span></code> as docclass if <a class="reference internal" href="usage/configuration.html#confval-language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">language</span></code></a> is
<code class="docutils literal notranslate"><span class="pre">ja</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx-quickstart</span></code> now allows a project version is empty</p></li>
<li><p>Fix :download: role on epub/qthelp builder. They ignore the role because they
don’t support it.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.viewcode</span></code> doesn’t work on epub building by default.
<code class="docutils literal notranslate"><span class="pre">viewcode_enable_epub</span></code> option</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.viewcode</span></code> disabled on singlehtml builder.</p></li>
<li><p>Use make-mode of <code class="docutils literal notranslate"><span class="pre">sphinx-quickstart</span></code> by default. To disable this, use
<code class="docutils literal notranslate"><span class="pre">-M</span></code> option</p></li>
<li><p>Fix <code class="docutils literal notranslate"><span class="pre">genindex.html</span></code>, Sphinx’s document template, link address to itself to
satisfy xhtml standard.</p></li>
<li><p>Use epub3 builder by default. And the old epub builder is renamed to epub2.</p></li>
<li><p>Fix <code class="docutils literal notranslate"><span class="pre">epub</span></code> and <code class="docutils literal notranslate"><span class="pre">epub3</span></code> builders that contained links to <code class="docutils literal notranslate"><span class="pre">genindex</span></code> even
if <code class="docutils literal notranslate"><span class="pre">epub_use_index</span> <span class="pre">=</span> <span class="pre">False</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">html_translator_class</span></code> is now deprecated.
Use <a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.set_translator" title="sphinx.application.Sphinx.set_translator"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_translator()</span></code></a> API instead.</p></li>
<li><p>Drop python 2.6 and 3.3 support</p></li>
<li><p>Drop epub3 builder’s <code class="docutils literal notranslate"><span class="pre">epub3_page_progression_direction</span></code> option (use
<code class="docutils literal notranslate"><span class="pre">epub3_writing_mode</span></code>).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2877">#2877</a>: Rename <code class="docutils literal notranslate"><span class="pre">latex_elements['footer']</span></code> to
<code class="docutils literal notranslate"><span class="pre">latex_elements['atendofbody']</span></code></p></li>
</ul>
<p>1.5a2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2983">#2983</a>: Rename <code class="docutils literal notranslate"><span class="pre">epub3_description</span></code> and <code class="docutils literal notranslate"><span class="pre">epub3_contributor</span></code> to
<code class="docutils literal notranslate"><span class="pre">epub_description</span></code> and <code class="docutils literal notranslate"><span class="pre">epub_contributor</span></code>.</p></li>
<li><p>Remove themes/basic/defindex.html; no longer used</p></li>
<li><p>Sphinx does not ship anymore (but still uses) LaTeX style file <code class="docutils literal notranslate"><span class="pre">fncychap</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2435">#2435</a>: Slim down quickstarted conf.py</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">sphinx.sty</span></code> latex package does not load itself “hyperref”, as this
is done later in the preamble of the latex output via <code class="docutils literal notranslate"><span class="pre">'hyperref'</span></code> key.</p></li>
<li><p>Sphinx does not ship anymore a custom modified LaTeX style file <code class="docutils literal notranslate"><span class="pre">tabulary</span></code>.
The non-modified package is used.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3057">#3057</a>: By default, footnote marks in latex PDF output are not preceded by a
space anymore, <code class="docutils literal notranslate"><span class="pre">\sphinxBeforeFootnote</span></code> allows user customization if needed.</p></li>
<li><p>LaTeX target requires that option <code class="docutils literal notranslate"><span class="pre">hyperfootnotes</span></code> of package <code class="docutils literal notranslate"><span class="pre">hyperref</span></code>
be left unchanged to its default (i.e. <code class="docutils literal notranslate"><span class="pre">true</span></code>) (refs: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3022">#3022</a>)</p></li>
</ul>
<p>1.5 final</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2986">#2986</a>: <code class="docutils literal notranslate"><span class="pre">themes/basic/defindex.html</span></code> is now deprecated</p></li>
<li><p>Emit warnings that will be deprecated in Sphinx 1.6 by default.
Users can change the behavior by setting the environment variable
PYTHONWARNINGS. Please refer <a class="reference internal" href="man/sphinx-build.html#when-deprecation-warnings-are-displayed"><span class="std std-ref">Deprecation Warnings</span></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2454">#2454</a>: new JavaScript variable <code class="docutils literal notranslate"><span class="pre">SOURCELINK_SUFFIX</span></code> is added</p></li>
</ul>
</section>
<section id="id2188">
<h3>Deprecated<a class="headerlink" href="#id2188" title="Link to this heading">¶</a></h3>
<p>These features are removed in Sphinx 1.6:</p>
<ul class="simple">
<li><p>LDML format support in i18n feature</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.addnodes.termsep</span></code></p></li>
<li><p>Some functions and classes in <code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat</span></code>:
<code class="docutils literal notranslate"><span class="pre">zip_longest</span></code>, <code class="docutils literal notranslate"><span class="pre">product</span></code>, <code class="docutils literal notranslate"><span class="pre">all</span></code>, <code class="docutils literal notranslate"><span class="pre">any</span></code>, <code class="docutils literal notranslate"><span class="pre">next</span></code>, <code class="docutils literal notranslate"><span class="pre">open</span></code>,
<code class="docutils literal notranslate"><span class="pre">class_types</span></code>, <code class="docutils literal notranslate"><span class="pre">base_exception</span></code>, <code class="docutils literal notranslate"><span class="pre">relpath</span></code>, <code class="docutils literal notranslate"><span class="pre">StringIO</span></code>, <code class="docutils literal notranslate"><span class="pre">BytesIO</span></code>.
Please use the standard library version instead;</p></li>
</ul>
<p>If any deprecation warning like <code class="docutils literal notranslate"><span class="pre">RemovedInSphinxXXXWarning</span></code> are displayed,
please refer <a class="reference internal" href="man/sphinx-build.html#when-deprecation-warnings-are-displayed"><span class="std std-ref">Deprecation Warnings</span></a>.</p>
</section>
<section id="id2189">
<h3>Features added<a class="headerlink" href="#id2189" title="Link to this heading">¶</a></h3>
<p>1.5a1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2951">#2951</a>: Add <code class="docutils literal notranslate"><span class="pre">--implicit-namespaces</span></code> PEP-0420 support to apidoc.</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">:caption:</span></code> option for sphinx.ext.inheritance_diagram.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2471">#2471</a>: Add config variable for default doctest flags.</p></li>
<li><p>Convert linkcheck builder to requests for better encoding handling</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2463">#2463</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2516">#2516</a>: Add keywords of “meta” directive to search index</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">:maxdepth:</span></code> option of toctree affects <code class="docutils literal notranslate"><span class="pre">secnumdepth</span></code> (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2547">#2547</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2575">#2575</a>: Now <code class="docutils literal notranslate"><span class="pre">sphinx.ext.graphviz</span></code> allows <code class="docutils literal notranslate"><span class="pre">:align:</span></code> option</p></li>
<li><p>Show warnings if unknown key is specified to <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a></p></li>
<li><p>Show warnings if no domains match with <a class="reference internal" href="usage/configuration.html#confval-primary_domain"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">primary_domain</span></code></a> (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2001">#2001</a>)</p></li>
<li><p>C++, show warnings when the kind of role is misleading for the kind
of target it refers to (e.g., using the <a class="reference internal" href="usage/extensions/autosummary.html#class" title="class"><code class="xref any py py-data docutils literal notranslate"><span class="pre">class</span></code></a> role for a function).</p></li>
<li><p>latex, writer abstracts more of text styling into customizable macros, e.g.
the <code class="docutils literal notranslate"><span class="pre">visit_emphasis</span></code> will output <code class="docutils literal notranslate"><span class="pre">\sphinxstyleemphasis</span></code> rather than
<code class="docutils literal notranslate"><span class="pre">\emph</span></code> (which may be in use elsewhere or in an added LaTeX package). See
list at end of <code class="docutils literal notranslate"><span class="pre">sphinx.sty</span></code> (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2686">#2686</a>)</p></li>
<li><p>latex, public names for environments and parameters used by note, warning,
and other admonition types, allowing full customizability from the
<code class="docutils literal notranslate"><span class="pre">'preamble'</span></code> key or an input file (ref: feature request <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2674">#2674</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2685">#2685</a>)</p></li>
<li><p>latex, better computes column widths of some tables (as a result, there will
be slight changes as tables now correctly fill the line width; ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2708">#2708</a>)</p></li>
<li><p>latex, sphinxVerbatim environment is more easily customizable (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2704">#2704</a>).
In addition to already existing VerbatimColor and VerbatimBorderColor:</p>
<ul>
<li><p>two lengths <code class="docutils literal notranslate"><span class="pre">\sphinxverbatimsep</span></code> and <code class="docutils literal notranslate"><span class="pre">\sphinxverbatimborder</span></code>,</p></li>
<li><p>booleans <code class="docutils literal notranslate"><span class="pre">\ifsphinxverbatimwithframe</span></code> and <code class="docutils literal notranslate"><span class="pre">\ifsphinxverbatimwrapslines</span></code>.</p></li>
</ul>
</li>
<li><p>latex, captions for literal blocks inside tables are handled, and long code
lines wrapped to fit table cell (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2704">#2704</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2597">#2597</a>: Show warning messages as darkred</p></li>
<li><p>latex, allow image dimensions using px unit (default is 96px=1in)</p></li>
<li><p>Show warnings if invalid dimension units found</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2650">#2650</a>: Add <code class="docutils literal notranslate"><span class="pre">--pdb</span></code> option to setup.py command</p></li>
<li><p>latex, make the use of <code class="docutils literal notranslate"><span class="pre">\small</span></code> for code listings customizable (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2721">#2721</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2663">#2663</a>: Add <code class="docutils literal notranslate"><span class="pre">--warning-is-error</span></code> option to setup.py command</p></li>
<li><p>Show warnings if deprecated latex options are used</p></li>
<li><p>Add sphinx.config.ENUM to check the config values is in candidates</p></li>
<li><p>math: Add hyperlink marker to each equations in HTML output</p></li>
<li><p>Add new theme <code class="docutils literal notranslate"><span class="pre">nonav</span></code> that doesn’t include any navigation links.
This is for any help generator like qthelp.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2680">#2680</a>: <a class="reference internal" href="usage/extensions/todo.html#module-sphinx.ext.todo" title="sphinx.ext.todo: Allow inserting todo items into documents."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.todo</span></code></a> now emits warnings if <a class="reference internal" href="usage/extensions/todo.html#confval-todo_emit_warnings"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">todo_emit_warnings</span></code></a> enabled.
Also, it emits an additional event named <a class="reference internal" href="usage/extensions/todo.html#event-todo-defined"><code class="xref any std std-event docutils literal notranslate"><span class="pre">todo-defined</span></code></a> to handle the TODO
entries in 3rd party extensions.</p></li>
<li><p>Python domain signature parser now uses the xref mixin for ‘exceptions’,
allowing exception classes to be autolinked.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2513">#2513</a>: Add <a class="reference internal" href="usage/configuration.html#confval-latex_engine"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_engine</span></code></a> to switch the LaTeX engine by conf.py</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2682">#2682</a>: C++, basic support for attributes (C++11 style and GNU style).
The new configuration variables ‘cpp_id_attributes’ and ‘cpp_paren_attributes’
can be used to introduce custom attributes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1958">#1958</a>: C++, add configuration variable ‘cpp_index_common_prefix’ for removing
prefixes from the index text of C++ objects.</p></li>
<li><p>C++, added concept directive. Thanks to mickk-on-cpp.</p></li>
<li><p>C++, added support for template introduction syntax. Thanks to mickk-on-cpp.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2725">#2725</a>: latex builder: allow to use user-defined template file (experimental)</p></li>
<li><p>apidoc now avoids invalidating cached files by not writing to files whose
content doesn’t change. This can lead to significant performance wins if
apidoc is run frequently.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2851">#2851</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.ext.math</span></code> emits missing-reference event if equation not found</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1210">#1210</a>: <code class="docutils literal notranslate"><span class="pre">eqref</span></code> role now supports cross reference</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2892">#2892</a>: Added <code class="docutils literal notranslate"><span class="pre">-a</span></code> (<code class="docutils literal notranslate"><span class="pre">--append-syspath</span></code>) option to <code class="docutils literal notranslate"><span class="pre">sphinx-apidoc</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1604">#1604</a>: epub3 builder: Obey font-related CSS when viewing in iBooks.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/646">#646</a>: <code class="docutils literal notranslate"><span class="pre">option</span></code> directive support ‘.’ character as a part of options</p></li>
<li><p>Add document about kindlegen and fix document structure for it.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2474">#2474</a>: Add <code class="docutils literal notranslate"><span class="pre">intersphinx_timeout</span></code> option to <code class="docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2926">#2926</a>: EPUB3 builder supports vertical mode (<code class="docutils literal notranslate"><span class="pre">epub3_writing_mode</span></code> option)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2695">#2695</a>: <code class="docutils literal notranslate"><span class="pre">build_sphinx</span></code> subcommand for setuptools handles exceptions as same
as <code class="docutils literal notranslate"><span class="pre">sphinx-build</span></code> does</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/326">#326</a>: <a class="reference internal" href="usage/restructuredtext/roles.html#role-numref" title="numref role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">numref</span></code></a> role can also refer sections</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2916">#2916</a>: <a class="reference internal" href="usage/restructuredtext/roles.html#role-numref" title="numref role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">numref</span></code></a> role can also refer caption as an its linktext</p></li>
</ul>
<p>1.5a2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3008">#3008</a>: <code class="docutils literal notranslate"><span class="pre">linkcheck</span></code> builder ignores self-signed certificate URL</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3020">#3020</a>: new <code class="docutils literal notranslate"><span class="pre">'geometry'</span></code> key to <code class="docutils literal notranslate"><span class="pre">latex_elements</span></code> whose default uses
LaTeX style file <code class="docutils literal notranslate"><span class="pre">geometry.sty</span></code> to set page layout</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2843">#2843</a>: Add :start-at: and :end-at: options to literalinclude directive</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2527">#2527</a>: Add <code class="docutils literal notranslate"><span class="pre">:reversed:</span></code> option to toctree directive</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">-t</span></code> and <code class="docutils literal notranslate"><span class="pre">-d</span></code> option to <code class="docutils literal notranslate"><span class="pre">sphinx-quickstart</span></code> to support templating
generated sphinx project.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3028">#3028</a>: Add <code class="docutils literal notranslate"><span class="pre">{path}</span></code> and <code class="docutils literal notranslate"><span class="pre">{basename}</span></code> to the format of
<code class="docutils literal notranslate"><span class="pre">figure_language_filename</span></code></p></li>
<li><p>new <code class="docutils literal notranslate"><span class="pre">'hyperref'</span></code> key in the <code class="docutils literal notranslate"><span class="pre">latex_elements</span></code> dictionary (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3030">#3030</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3022">#3022</a>: Allow code-blocks in footnotes for LaTeX PDF output</p></li>
</ul>
<p>1.5b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2513">#2513</a>: A better default settings for XeLaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3096">#3096</a>: <code class="docutils literal notranslate"><span class="pre">'maxlistdepth'</span></code> key to work around LaTeX list limitations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3060">#3060</a>: autodoc supports documentation for attributes of Enum class. Now
autodoc render just the value of Enum attributes instead of Enum attribute
representation.</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--extensions</span></code> to <code class="docutils literal notranslate"><span class="pre">sphinx-quickstart</span></code> to support enable arbitrary
extensions from command line (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2904">#2904</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3104">#3104</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3122">#3122</a>: <code class="docutils literal notranslate"><span class="pre">'sphinxsetup'</span></code> for key=value styling of Sphinx LaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3071">#3071</a>: Autodoc: Allow mocked module decorators to pass-through functions
unchanged</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2495">#2495</a>: linkcheck: Allow skipping anchor checking using
<a class="reference internal" href="usage/configuration.html#confval-linkcheck_anchors_ignore"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_anchors_ignore</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3083">#3083</a>: let Unicode no-break space act like LaTeX <code class="docutils literal notranslate"><span class="pre">~</span></code> (fixed <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3019">#3019</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3116">#3116</a>: allow word wrap in PDF output for inline literals (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3110">#3110</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/930">#930</a>: sphinx-apidoc allow wildcards for excluding paths. Thanks to Nick
Coghlan.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3121">#3121</a>: add <code class="docutils literal notranslate"><span class="pre">inlineliteralwraps</span></code> option to control if inline literal
word-wraps in latex</p></li>
</ul>
<p>1.5 final</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3095">#3095</a>: Add <a class="reference internal" href="usage/configuration.html#confval-tls_verify"><code class="xref std std-confval docutils literal notranslate"><span class="pre">tls_verify</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-tls_cacerts"><code class="xref std std-confval docutils literal notranslate"><span class="pre">tls_cacerts</span></code></a> to support
self-signed HTTPS servers in linkcheck and intersphinx</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2215">#2215</a>: make.bat generated by sphinx-quickstart can be called from another dir.
Thanks to Timotheus Kampik.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3185">#3185</a>: Add new warning type <code class="docutils literal notranslate"><span class="pre">misc.highlighting_failure</span></code></p></li>
</ul>
</section>
<section id="id2246">
<h3>Bugs fixed<a class="headerlink" href="#id2246" title="Link to this heading">¶</a></h3>
<p>1.5a1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2707">#2707</a>: (latex) the column width is badly computed for tabular</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2799">#2799</a>: Sphinx installs roles and directives automatically on importing sphinx
module. Now Sphinx installs them on running application.</p></li>
<li><p><a class="reference internal" href="usage/extensions/autodoc.html#module-sphinx.ext.autodoc" title="sphinx.ext.autodoc: Include documentation from docstrings."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.autodoc</span></code></a> crashes if target code imports * from mock modules
by <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_mock_imports"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">autodoc_mock_imports</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1953">#1953</a>: <code class="docutils literal notranslate"><span class="pre">Sphinx.add_node</span></code> does not add handlers the translator installed by
<code class="docutils literal notranslate"><span class="pre">html_translator_class</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1797">#1797</a>: text builder inserts blank line on top</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2894">#2894</a>: quickstart main() doesn’t use argv argument</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2874">#2874</a>: gettext builder could not extract all text under the <code class="docutils literal notranslate"><span class="pre">only</span></code>
directives</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2485">#2485</a>: autosummary crashes with multiple source_suffix values</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1734">#1734</a>: Could not translate the caption of toctree directive</p></li>
<li><p>Could not translate the content of meta directive (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1734">#1734</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2550">#2550</a>: external links are opened in help viewer</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2687">#2687</a>: Running Sphinx multiple times produces ‘already registered’ warnings</p></li>
</ul>
<p>1.5a2</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2810">#2810</a>: Problems with pdflatex in an Italian document</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">latex_elements.papersize</span></code> to specify papersize of LaTeX in Makefile</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2988">#2988</a>: linkcheck: retry with GET request if denied HEAD request</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2990">#2990</a>: linkcheck raises “Can’t convert ‘bytes’ object to str implicitly” error
if linkcheck_anchors enabled</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3004">#3004</a>: Invalid link types “top” and “up” are used</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3009">#3009</a>: Bad rendering of parsed-literals in LaTeX since Sphinx 1.4.4</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3000">#3000</a>: <code class="docutils literal notranslate"><span class="pre">option</span></code> directive generates invalid HTML anchors</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2984">#2984</a>: Invalid HTML has been generated if <a class="reference internal" href="usage/configuration.html#confval-html_split_index"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_split_index</span></code></a> enabled</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2986">#2986</a>: themes/basic/defindex.html should be changed for html5 friendly</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2987">#2987</a>: Invalid HTML has been generated if multiple IDs are assigned to a list</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2891">#2891</a>: HTML search does not provide all the results</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1986">#1986</a>: Title in PDF Output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/147">#147</a>: Problem with latex chapter style</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3018">#3018</a>: LaTeX problem with page layout dimensions and chapter titles</p></li>
<li><p>Fix an issue with <code class="docutils literal notranslate"><span class="pre">\pysigline</span></code> in LaTeX style file (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3023">#3023</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3038">#3038</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.ext.math*</span></code> raises TypeError if labels are duplicated</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3031">#3031</a>: incompatibility with LaTeX package <code class="docutils literal notranslate"><span class="pre">tocloft</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3003">#3003</a>: literal blocks in footnotes are not supported by Latex</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3047">#3047</a>: spacing before footnote in pdf output is not coherent and allows breaks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3045">#3045</a>: HTML search index creator should ignore “raw” content if now html</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3039">#3039</a>: English stemmer returns wrong word if the word is capitalized</p></li>
<li><p>Fix make-mode Makefile template (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3056">#3056</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2936">#2936</a>)</p></li>
</ul>
<p>1.5b1</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2432">#2432</a>: Fix unwanted * between varargs and keyword only args. Thanks to Alex
Grönholm.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3062">#3062</a>: Failed to build PDF using 1.5a2 (undefined <code class="docutils literal notranslate"><span class="pre">\hypersetup</span></code> for
Japanese documents since <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3030">PR#3030</a>)</p></li>
<li><p>Better rendering of multiline signatures in html.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/777">#777</a>: LaTeX output “too deeply nested” (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3096">#3096</a>)</p></li>
<li><p>Let LaTeX image inclusion obey <code class="docutils literal notranslate"><span class="pre">scale</span></code> before textwidth fit (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2865">#2865</a>,
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3059">#3059</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3019">#3019</a>: LaTeX fails on description of C function with arguments (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3083">#3083</a>)</p></li>
<li><p>fix latex inline literals where <code class="docutils literal notranslate"><span class="pre"><</span> <span class="pre">></span> <span class="pre">-</span></code> gobbled a space</p></li>
</ul>
<p>1.5 final</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3069">#3069</a>: Even if <code class="docutils literal notranslate"><span class="pre">'babel'</span></code> key is set to empty string, LaTeX output contains
one <code class="docutils literal notranslate"><span class="pre">\addto\captions...</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3123">#3123</a>: user <code class="docutils literal notranslate"><span class="pre">'babel'</span></code> key setting is not obeyed anymore</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3155">#3155</a>: Fix JavaScript for <a class="reference internal" href="usage/configuration.html#confval-html_sourcelink_suffix"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_sourcelink_suffix</span></code></a> fails with IE and Opera</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3085">#3085</a>: keep current directory after breaking build documentation. Thanks to
Timotheus Kampik.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3181">#3181</a>: pLaTeX crashes with a section contains endash</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3180">#3180</a>: latex: add stretch/shrink between successive singleline or
multipleline cpp signatures (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3072">#3072</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3128">#3128</a>: globing images does not support .svgz file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3015">#3015</a>: fix a broken test on Windows.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1843">#1843</a>: Fix documentation of descriptor classes that have a custom metaclass.
Thanks to Erik Bray.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3190">#3190</a>: util.split_docinfo fails to parse multi-line field bodies</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3024">#3024</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3037">#3037</a>: In Python3, application.Sphinx._log crushed when the log message
cannot be encoded into console encoding.</p></li>
</ul>
</section>
<section id="id2301">
<h3>Testing<a class="headerlink" href="#id2301" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>To simplify, sphinx uses external mock package even if unittest.mock exists.</p></li>
</ul>
</section>
</section>
<section id="release-1-4-9-released-nov-23-2016">
<h2>Release 1.4.9 (released Nov 23, 2016)<a class="headerlink" href="#release-1-4-9-released-nov-23-2016" title="Link to this heading">¶</a></h2>
<section id="id2302">
<h3>Bugs fixed<a class="headerlink" href="#id2302" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2936">#2936</a>: Fix doc/Makefile that can’t build man because doc/man exists</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3058">#3058</a>: Using the same ‘caption’ attribute in multiple ‘toctree’ directives
results in warning / error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3068">#3068</a>: Allow the ‘=’ character in the -D option of sphinx-build.py</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3074">#3074</a>: <code class="docutils literal notranslate"><span class="pre">add_source_parser()</span></code> crashes in debug mode</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3135">#3135</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autodoc</span></code> crashes with plain Callable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3150">#3150</a>: Fix query word splitter in JavaScript. It behaves as same as Python’s
regular expression.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3093">#3093</a>: gettext build broken on substituted images.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3093">#3093</a>: gettext build broken on image node under <code class="docutils literal notranslate"><span class="pre">note</span></code> directive.</p></li>
<li><p>imgmath: crashes on showing error messages if image generation failed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3117">#3117</a>: LaTeX writer crashes if admonition is placed before first section title</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/3164">#3164</a>: Change search order of <code class="docutils literal notranslate"><span class="pre">sphinx.ext.inheritance_diagram</span></code></p></li>
</ul>
</section>
</section>
<section id="release-1-4-8-released-oct-1-2016">
<h2>Release 1.4.8 (released Oct 1, 2016)<a class="headerlink" href="#release-1-4-8-released-oct-1-2016" title="Link to this heading">¶</a></h2>
<section id="id2313">
<h3>Bugs fixed<a class="headerlink" href="#id2313" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2996">#2996</a>: The wheel package of Sphinx got crash with ImportError</p></li>
</ul>
</section>
</section>
<section id="release-1-4-7-released-oct-1-2016">
<h2>Release 1.4.7 (released Oct 1, 2016)<a class="headerlink" href="#release-1-4-7-released-oct-1-2016" title="Link to this heading">¶</a></h2>
<section id="id2315">
<h3>Bugs fixed<a class="headerlink" href="#id2315" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2890">#2890</a>: Quickstart should return an error consistently on all error conditions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2870">#2870</a>: flatten genindex columns’ heights.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2856">#2856</a>: Search on generated HTML site doesn’t find some symbols</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2882">#2882</a>: Fall back to a GET request on 403 status in linkcheck</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2902">#2902</a>: jsdump.loads fails to load search index if keywords starts with
underscore</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2900">#2900</a>: Fix epub content.opf: add auto generated orphan files to spine.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2899">#2899</a>: Fix <code class="docutils literal notranslate"><span class="pre">hasdoc()</span></code> function in Jinja2 template. It will detect
<code class="docutils literal notranslate"><span class="pre">genindex</span></code>, <code class="docutils literal notranslate"><span class="pre">search</span></code> also.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2901">#2901</a>: Fix epub result: skip creating links from image tags to original image
files.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2917">#2917</a>: inline code is hyphenated on HTML</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1462">#1462</a>: autosummary warns for namedtuple with attribute with trailing
underscore</p></li>
<li><p>Could not reference equations if <code class="docutils literal notranslate"><span class="pre">:nowrap:</span></code> option specified</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2873">#2873</a>: code-block overflow in latex (due to commas)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1060">#1060</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2056">#2056</a>: sphinx.ext.intersphinx: broken links are generated if relative
paths are used in <a class="reference internal" href="usage/extensions/intersphinx.html#confval-intersphinx_mapping"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">intersphinx_mapping</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2931">#2931</a>: code-block directive with same :caption: causes warning of duplicate
target. Now <a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a> and <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> does not define hyperlink
target using its caption automatically.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2962">#2962</a>: latex: missing label of longtable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2968">#2968</a>: autodoc: show-inheritance option breaks docstrings</p></li>
</ul>
</section>
</section>
<section id="release-1-4-6-released-aug-20-2016">
<h2>Release 1.4.6 (released Aug 20, 2016)<a class="headerlink" href="#release-1-4-6-released-aug-20-2016" title="Link to this heading">¶</a></h2>
<section id="id2332">
<h3>Incompatible changes<a class="headerlink" href="#id2332" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2867">#2867</a>: linkcheck builder crashes with six-1.4. Now Sphinx depends on six-1.5
or later</p></li>
</ul>
</section>
<section id="id2334">
<h3>Bugs fixed<a class="headerlink" href="#id2334" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>applehelp: Sphinx crashes if <code class="docutils literal notranslate"><span class="pre">hiutil</span></code> or <code class="docutils literal notranslate"><span class="pre">codesign</span></code> commands not found</p></li>
<li><p>Fix <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code> abort issue when build dir contains regular files like
<code class="docutils literal notranslate"><span class="pre">DS_Store</span></code>.</p></li>
<li><p>Reduce epubcheck warnings/errors:</p>
<ul>
<li><p>Fix DOCTYPE to html5</p></li>
<li><p>Change extension from .html to .xhtml.</p></li>
<li><p>Disable search page on epub results</p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2778">#2778</a>: Fix autodoc crashes if obj.__dict__ is a property method and raises
exception</p></li>
<li><p>Fix duplicated toc in epub3 output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2775">#2775</a>: Fix failing linkcheck with servers not supporting identity encoding</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2833">#2833</a>: Fix formatting instance annotations in ext.autodoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1911">#1911</a>: <code class="docutils literal notranslate"><span class="pre">-D</span></code> option of <code class="docutils literal notranslate"><span class="pre">sphinx-build</span></code> does not override the <code class="docutils literal notranslate"><span class="pre">extensions</span></code>
variable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2789">#2789</a>: <a class="reference internal" href="usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="sphinx.ext.intersphinx: Link to other Sphinx documentation."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></a> generates wrong hyperlinks if the inventory is
given</p></li>
<li><p>parsing errors for caption of code-blocks are displayed in document
(ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2845">#2845</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2846">#2846</a>: <code class="docutils literal notranslate"><span class="pre">singlehtml</span></code> builder does not include figure numbers</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2816">#2816</a>: Fix data from builds cluttering the <code class="docutils literal notranslate"><span class="pre">Domain.initial_data</span></code> class
attributes</p></li>
</ul>
</section>
</section>
<section id="release-1-4-5-released-jul-13-2016">
<h2>Release 1.4.5 (released Jul 13, 2016)<a class="headerlink" href="#release-1-4-5-released-jul-13-2016" title="Link to this heading">¶</a></h2>
<section id="id2343">
<h3>Incompatible changes<a class="headerlink" href="#id2343" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>latex, inclusion of non-inline images from image directive resulted in
non-coherent whitespaces depending on original image width; new behaviour
by necessity differs from earlier one in some cases. (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2672">#2672</a>)</p></li>
<li><p>latex, use of <code class="docutils literal notranslate"><span class="pre">\includegraphics</span></code> to refer to Sphinx custom variant is
deprecated; in future it will revert to original LaTeX macro, custom one
already has alternative name <code class="docutils literal notranslate"><span class="pre">\sphinxincludegraphics</span></code>.</p></li>
</ul>
</section>
<section id="id2345">
<h3>Features added<a class="headerlink" href="#id2345" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>new config option <code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_keep_old_macro_names</span></code>, defaults to True. If False,
lets macros (for text styling) be defined only with <code class="docutils literal notranslate"><span class="pre">\sphinx</span></code>-prefixed names</p></li>
<li><p>latex writer allows user customization of “shadowed” boxes (topics), via
three length variables.</p></li>
<li><p>woff-format web font files now supported by the epub builder.</p></li>
</ul>
</section>
<section id="id2346">
<h3>Bugs fixed<a class="headerlink" href="#id2346" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>jsdump fix for python 3: fixes the HTML search on python > 3</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2676">#2676</a>: (latex) Error with verbatim text in captions since Sphinx 1.4.4</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2629">#2629</a>: memoir class crashes LaTeX. Fixed by
<code class="docutils literal notranslate"><span class="pre">latex_keep_old_macro_names=False</span></code> (ref 2675)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2684">#2684</a>: <a class="reference internal" href="usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="sphinx.ext.intersphinx: Link to other Sphinx documentation."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></a> crashes with six-1.4.1</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2679">#2679</a>: <code class="docutils literal notranslate"><span class="pre">float</span></code> package needed for <code class="docutils literal notranslate"><span class="pre">'figure_align':</span> <span class="pre">'H'</span></code> latex option</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2671">#2671</a>: image directive may lead to inconsistent spacing in pdf</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2705">#2705</a>: <code class="docutils literal notranslate"><span class="pre">toctree</span></code> generates empty bullet_list if <code class="docutils literal notranslate"><span class="pre">:titlesonly:</span></code> specified</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2479">#2479</a>: <a class="reference internal" href="usage/extensions/viewcode.html#module-sphinx.ext.viewcode" title="sphinx.ext.viewcode: Add links to a highlighted version of the source code."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.viewcode</span></code></a> uses python2 highlighter by default</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2700">#2700</a>: HtmlHelp builder has hard coded index.html</p></li>
<li><p>latex, since 1.4.4 inline literal text is followed by spurious space</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2722">#2722</a>: C++, fix id generation for var/member declarations to include
namespaces.</p></li>
<li><p>latex, images (from image directive) in lists or quoted blocks did not obey
indentation (fixed together with <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2671">#2671</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2733">#2733</a>: since Sphinx 1.4.4 <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">latexpdf</span></code> generates lots of hyperref
warnings</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2731">#2731</a>: <a class="reference internal" href="usage/extensions/autodoc.html#module-sphinx.ext.autodoc" title="sphinx.ext.autodoc: Include documentation from docstrings."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.autodoc</span></code></a> does not access propertymethods which raises any
exceptions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2666">#2666</a>: C++, properly look up nested names involving constructors.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2579">#2579</a>: Could not refer a label including both spaces and colons via
<a class="reference internal" href="usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="sphinx.ext.intersphinx: Link to other Sphinx documentation."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2718">#2718</a>: Sphinx crashes if the document file is not readable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2699">#2699</a>: hyperlinks in help HTMLs are broken if <a class="reference internal" href="usage/configuration.html#confval-html_file_suffix"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_file_suffix</span></code></a> is set</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2723">#2723</a>: extra spaces in latex pdf output from multirow cell</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2735">#2735</a>: latexpdf <code class="docutils literal notranslate"><span class="pre">Underfull</span> <span class="pre">\hbox</span> <span class="pre">(badness</span> <span class="pre">10000)</span></code> warnings from title page</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2667">#2667</a>: latex crashes if resized images appeared in section title</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2763">#2763</a>: (html) Provide default value for required <code class="docutils literal notranslate"><span class="pre">alt</span></code> attribute for image
tags of SVG source, required to validate and now consistent w/ other formats.</p></li>
</ul>
</section>
</section>
<section id="release-1-4-4-released-jun-12-2016">
<h2>Release 1.4.4 (released Jun 12, 2016)<a class="headerlink" href="#release-1-4-4-released-jun-12-2016" title="Link to this heading">¶</a></h2>
<section id="id2367">
<h3>Bugs fixed<a class="headerlink" href="#id2367" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2630">#2630</a>: latex: sphinx.sty notice environment formatting problem</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2632">#2632</a>: Warning directives fail in quote environment latex build</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2633">#2633</a>: Sphinx crashes with old styled indices</p></li>
<li><p>Fix a <code class="docutils literal notranslate"><span class="pre">\begin{\minipage}</span></code> typo in sphinx.sty from 1.4.2 (ref: 68becb1)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2622">#2622</a>: Latex produces empty pages after title and table of contents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2640">#2640</a>: 1.4.2 LaTeX crashes if code-block inside warning directive</p></li>
<li><p>Let LaTeX use straight quotes also in inline code (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2627">#2627</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2351">#2351</a>: latex crashes if enumerated lists are placed on footnotes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2646">#2646</a>: latex crashes if math contains twice empty lines</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2480">#2480</a>: <a class="reference internal" href="usage/extensions/autodoc.html#module-sphinx.ext.autodoc" title="sphinx.ext.autodoc: Include documentation from docstrings."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.autodoc</span></code></a>: memory addresses were shown</p></li>
<li><p>latex: allow code-blocks appearing inside lists and quotes at maximal nesting
depth (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/777">#777</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2624">#2624</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2651">#2651</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2635">#2635</a>: Latex code directives produce inconsistent frames based on viewing
resolution</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2639">#2639</a>: Sphinx now bundles iftex.sty</p></li>
<li><p>Failed to build PDF with framed.sty 0.95</p></li>
<li><p>Sphinx now bundles needspace.sty</p></li>
</ul>
</section>
</section>
<section id="release-1-4-3-released-jun-5-2016">
<h2>Release 1.4.3 (released Jun 5, 2016)<a class="headerlink" href="#release-1-4-3-released-jun-5-2016" title="Link to this heading">¶</a></h2>
<section id="id2382">
<h3>Bugs fixed<a class="headerlink" href="#id2382" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2530">#2530</a>: got “Counter too large” error on building PDF if large numbered
footnotes existed in admonitions</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">width</span></code> option of figure directive does not work if <code class="docutils literal notranslate"><span class="pre">align</span></code> option
specified at same time (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2595">#2595</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2590">#2590</a>: The <code class="docutils literal notranslate"><span class="pre">inputenc</span></code> package breaks compiling under lualatex and xelatex</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2540">#2540</a>: date on latex front page use different font</p></li>
<li><p>Suppress “document isn’t included in any toctree” warning if the document is
included (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2603">#2603</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2614">#2614</a>: Some tables in PDF output will end up shifted if user sets non zero
parindent in preamble</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2602">#2602</a>: URL redirection breaks the hyperlinks generated by
<a class="reference internal" href="usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="sphinx.ext.intersphinx: Link to other Sphinx documentation."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2613">#2613</a>: Show warnings if merged extensions are loaded</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2619">#2619</a>: make sure amstext LaTeX package always loaded (ref: d657225, 488ee52,
9d82cad and <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2615">#2615</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2593">#2593</a>: latex crashes if any figures in the table</p></li>
</ul>
</section>
</section>
<section id="release-1-4-2-released-may-29-2016">
<h2>Release 1.4.2 (released May 29, 2016)<a class="headerlink" href="#release-1-4-2-released-may-29-2016" title="Link to this heading">¶</a></h2>
<section id="id2394">
<h3>Features added<a class="headerlink" href="#id2394" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Now <a class="reference internal" href="usage/configuration.html#confval-suppress_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">suppress_warnings</span></code></a> accepts following configurations
(ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2451">#2451</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2466">#2466</a>):</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">app.add_node</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">app.add_directive</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">app.add_role</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">app.add_generic_role</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">app.add_source_parser</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">image.data_uri</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">image.nonlocal_uri</span></code></p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2453">#2453</a>: 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 <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2446">#2446</a>).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2459">#2459</a>: the framing of literal code-blocks in LaTeX output (and not only the
code lines themselves) obey the indentation in lists or quoted blocks.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2343">#2343</a>: the long source lines in code-blocks are wrapped (without modifying
the line numbering) in LaTeX output (ref <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1534">#1534</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2304">#2304</a>).</p></li>
</ul>
</section>
<section id="id2403">
<h3>Bugs fixed<a class="headerlink" href="#id2403" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2370">#2370</a>: the equations are slightly misaligned in LaTeX writer</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1817">#1817</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2077">#2077</a>: suppress pep8 warnings on conf.py generated by sphinx-quickstart</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2407">#2407</a>: building docs crash if document includes large data image URIs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2436">#2436</a>: Sphinx does not check version by <a class="reference internal" href="usage/configuration.html#confval-needs_sphinx"><code class="xref std std-confval docutils literal notranslate"><span class="pre">needs_sphinx</span></code></a> if loading
extensions failed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2397">#2397</a>: Setup shorthandoff for Turkish documents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2447">#2447</a>: VerbatimBorderColor wrongly used also for captions of PDF</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2456">#2456</a>: C++, fix crash related to document merging (e.g., singlehtml and Latex
builders).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2446">#2446</a>: latex(pdf) sets local tables of contents (or more generally topic
nodes) in unbreakable boxes, causes overflow at bottom</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2476">#2476</a>: Omit MathJax markers if :nowrap: is given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2465">#2465</a>: latex builder fails in case no caption option is provided to toctree
directive</p></li>
<li><p>Sphinx crashes if self referenced toctree found</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2481">#2481</a>: spelling mistake for mecab search splitter. Thanks to Naoki Sato.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2309">#2309</a>: Fix could not refer “indirect hyperlink targets” by ref-role</p></li>
<li><p>intersphinx fails if mapping URL contains any port</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2088">#2088</a>: intersphinx crashes if the mapping URL requires basic auth</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2304">#2304</a>: auto line breaks in latexpdf codeblocks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1534">#1534</a>: Word wrap long lines in Latex verbatim blocks</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2460">#2460</a>: too much white space on top of captioned literal blocks in PDF output</p></li>
<li><p>Show error reason when multiple math extensions are loaded (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2499">#2499</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2483">#2483</a>: any figure number was not assigned if figure title contains only non
text objects</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2501">#2501</a>: Unicode subscript numbers are normalized in LaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2492">#2492</a>: Figure directive with :figwidth: generates incorrect Latex-code</p></li>
<li><p>The caption of figure is always put on center even if <code class="docutils literal notranslate"><span class="pre">:align:</span></code> was
specified</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2526">#2526</a>: LaTeX writer crashes if the section having only images</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2522">#2522</a>: Sphinx touches mo files under installed directory that caused
permission error.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2536">#2536</a>: C++, fix crash when an immediately nested scope has the same name as
the current scope.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2555">#2555</a>: Fix crash on any-references with unicode.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2517">#2517</a>: wrong bookmark encoding in PDF if using LuaLaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2521">#2521</a>: generated Makefile causes BSD make crashed if sphinx-build not found</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2470">#2470</a>: <code class="docutils literal notranslate"><span class="pre">typing</span></code> backport package causes autodoc errors with python 2.7</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code> crashes if non-string value is used for key of
<a class="reference internal" href="usage/extensions/intersphinx.html#confval-intersphinx_mapping"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">intersphinx_mapping</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2518">#2518</a>: <a class="reference internal" href="usage/extensions/intersphinx.html#confval-intersphinx_mapping"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">intersphinx_mapping</span></code></a> disallows non alphanumeric keys</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2558">#2558</a>: unpack error on devhelp builder</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2561">#2561</a>: Info builder crashes when a footnote contains a link</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2565">#2565</a>: The descriptions of objects generated by <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosummary</span></code>
overflow lines at LaTeX writer</p></li>
<li><p>Extend pdflatex config in sphinx.sty to subparagraphs (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2551">#2551</a>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2445">#2445</a>: <a class="reference internal" href="usage/configuration.html#confval-rst_prolog"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">rst_prolog</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-rst_epilog"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">rst_epilog</span></code></a> affect to non reST sources</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2576">#2576</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.ext.imgmath</span></code> crashes if subprocess raises error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2577">#2577</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.ext.imgmath</span></code>: Invalid argument are passed to dvisvgm</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2556">#2556</a>: Xapian search does not work with Python 3</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2581">#2581</a>: The search doesn’t work if language=”es” (Spanish)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2382">#2382</a>: Adjust spacing after abbreviations on figure numbers in LaTeX writer</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2383">#2383</a>: The generated footnote by <a class="reference internal" href="usage/configuration.html#confval-latex_show_urls"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_show_urls</span></code></a> overflows lines</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2497">#2497</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2552">#2552</a>: The label of search button does not fit for the button itself</p></li>
</ul>
</section>
</section>
<section id="release-1-4-1-released-apr-12-2016">
<h2>Release 1.4.1 (released Apr 12, 2016)<a class="headerlink" href="#release-1-4-1-released-apr-12-2016" title="Link to this heading">¶</a></h2>
<section id="id2446">
<h3>Incompatible changes<a class="headerlink" href="#id2446" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>The default format of <a class="reference internal" href="usage/configuration.html#confval-today_fmt"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">today_fmt</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-html_last_updated_fmt"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_last_updated_fmt</span></code></a> is back to
strftime format again. Locale Date Markup Language is also supported for
backward compatibility until Sphinx 1.5.</p></li>
</ul>
</section>
<section id="translations">
<h3>Translations<a class="headerlink" href="#translations" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Added Welsh translation, thanks to Geraint Palmer.</p></li>
<li><p>Added Greek translation, thanks to Stelios Vitalis.</p></li>
<li><p>Added Esperanto translation, thanks to Dinu Gherman.</p></li>
<li><p>Added Hindi translation, thanks to Purnank H. Ghumalia.</p></li>
<li><p>Added Romanian translation, thanks to Razvan Stefanescu.</p></li>
</ul>
</section>
<section id="id2447">
<h3>Bugs fixed<a class="headerlink" href="#id2447" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>C++, added support for <code class="docutils literal notranslate"><span class="pre">extern</span></code> and <code class="docutils literal notranslate"><span class="pre">thread_local</span></code>.</p></li>
<li><p>C++, type declarations are now using the prefixes <code class="docutils literal notranslate"><span class="pre">typedef</span></code>, <code class="docutils literal notranslate"><span class="pre">using</span></code>, and
<code class="docutils literal notranslate"><span class="pre">type</span></code>, depending on the style of declaration.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2413">#2413</a>: C++, fix crash on duplicate declarations</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2394">#2394</a>: Sphinx crashes when html_last_updated_fmt is invalid</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2408">#2408</a>: dummy builder not available in Makefile and make.bat</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2412">#2412</a>: hyperlink targets are broken in LaTeX builder</p></li>
<li><p>figure directive crashes if non paragraph item is given as caption</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2418">#2418</a>: time formats no longer allowed in today_fmt</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2395">#2395</a>: Sphinx crashes if unicode character in image filename</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2396">#2396</a>: “too many values to unpack” in genindex-single</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2405">#2405</a>: numref link in PDF jumps to the wrong location</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2414">#2414</a>: missing number in PDF hyperlinks to code listings</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2440">#2440</a>: wrong import for gmtime. Thanks to Uwe L. Korn.</p></li>
</ul>
</section>
</section>
<section id="release-1-4-released-mar-28-2016">
<h2>Release 1.4 (released Mar 28, 2016)<a class="headerlink" href="#release-1-4-released-mar-28-2016" title="Link to this heading">¶</a></h2>
<section id="id2458">
<h3>Incompatible changes<a class="headerlink" href="#id2458" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Drop <code class="docutils literal notranslate"><span class="pre">PorterStemmer</span></code> package support. Use <code class="docutils literal notranslate"><span class="pre">PyStemmer</span></code> instead of
<code class="docutils literal notranslate"><span class="pre">PorterStemmer</span></code> to accelerate stemming.</p></li>
<li><p>sphinx_rtd_theme has become optional. Please install it manually.
Refs <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2087">#2087</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2086">#2086</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1845">#1845</a> and <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2097">#2097</a>. Thanks to Victor Zverovich.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2231">#2231</a>: Use DUrole instead of DUspan for custom roles in LaTeX writer. It
enables to take title of roles as an argument of custom macros.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2022">#2022</a>: ‘Thumbs.db’ and ‘.DS_Store’ are added to <a class="reference internal" href="usage/configuration.html#confval-exclude_patterns"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">exclude_patterns</span></code></a> default
values in conf.py that will be provided on sphinx-quickstart.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2027">#2027</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2208">#2208</a>: The <code class="docutils literal notranslate"><span class="pre">html_title</span></code> accepts string values only. And The None
value cannot be accepted.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.ext.graphviz</span></code>: show graph image in inline by default</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2060">#2060</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2224">#2224</a>: The <code class="docutils literal notranslate"><span class="pre">manpage</span></code> role now generate <code class="docutils literal notranslate"><span class="pre">sphinx.addnodes.manpage</span></code>
node instead of <code class="docutils literal notranslate"><span class="pre">sphinx.addnodes.literal_emphasis</span></code> node.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2022">#2022</a>: <a class="reference internal" href="usage/configuration.html#confval-html_extra_path"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_extra_path</span></code></a> also copies dotfiles in the extra directory,
and refers to <a class="reference internal" href="usage/configuration.html#confval-exclude_patterns"><code class="xref std std-confval docutils literal notranslate"><span class="pre">exclude_patterns</span></code></a> to exclude extra files and
directories.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2300">#2300</a>: enhance autoclass:: to use the docstring of __new__ if __init__
method’s is missing of empty</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2251">#2251</a>: Previously, under glossary directives, multiple terms for one
definition are converted into single <code class="docutils literal notranslate"><span class="pre">term</span></code> node and the each terms in the
term node are separated by <code class="docutils literal notranslate"><span class="pre">termsep</span></code> node. In new implementation, each terms
are converted into individual <code class="docutils literal notranslate"><span class="pre">term</span></code> nodes and <code class="docutils literal notranslate"><span class="pre">termsep</span></code> node is removed.
By this change, output layout of every builders are changed a bit.</p></li>
<li><p>The default highlight language is now Python 3. This means that source code
is highlighted as Python 3 (which is mostly a superset of Python 2), and no
parsing is attempted to distinguish valid code. To get the old behavior back,
add <code class="docutils literal notranslate"><span class="pre">highlight_language</span> <span class="pre">=</span> <span class="pre">"python"</span></code> to conf.py.</p></li>
<li><p><a class="reference external" href="https://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns">Locale Date Markup Language</a> like
<code class="docutils literal notranslate"><span class="pre">"MMMM</span> <span class="pre">dd,</span> <span class="pre">YYYY"</span></code> is default format for <a class="reference internal" href="usage/configuration.html#confval-today_fmt"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">today_fmt</span></code></a> and
<a class="reference internal" href="usage/configuration.html#confval-html_last_updated_fmt"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_last_updated_fmt</span></code></a>. However strftime format like <code class="docutils literal notranslate"><span class="pre">"%B</span> <span class="pre">%d,</span> <span class="pre">%Y"</span></code> is also
supported for backward compatibility until Sphinx 1.5. Later format will be
disabled from Sphinx 1.5.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2327">#2327</a>: <code class="docutils literal notranslate"><span class="pre">latex_use_parts</span></code> is deprecated now. Use <a class="reference internal" href="usage/configuration.html#confval-latex_toplevel_sectioning"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_toplevel_sectioning</span></code></a>
instead.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2337">#2337</a>: Use <code class="docutils literal notranslate"><span class="pre">\url{URL}</span></code> macro instead of <code class="docutils literal notranslate"><span class="pre">\href{URL}{URL}</span></code> in LaTeX writer.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1498">#1498</a>: manpage writer: don’t make whole of item in definition list bold if it
includes strong node.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/582">#582</a>: Remove hint message from quick search box for html output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2378">#2378</a>: Sphinx now bundles newfloat.sty</p></li>
</ul>
</section>
<section id="id2477">
<h3>Features added<a class="headerlink" href="#id2477" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2092">#2092</a>: add todo directive support in napoleon package.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1962">#1962</a>: when adding directives, roles or nodes from an extension, warn if such
an element is already present (built-in or added by another extension).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1909">#1909</a>: Add “doc” references to Intersphinx inventories.</p></li>
<li><p>C++ type alias support (e.g., <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">type::</span> <span class="pre">T</span> <span class="pre">=</span> <span class="pre">int</span></code>).</p></li>
<li><p>C++ template support for classes, functions, type aliases, and variables
(<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1729">#1729</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1314">#1314</a>).</p></li>
<li><p>C++, added new scope management directives <code class="docutils literal notranslate"><span class="pre">namespace-push</span></code> and
<code class="docutils literal notranslate"><span class="pre">namespace-pop</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1970">#1970</a>: Keyboard shortcuts to navigate Next and Previous topics</p></li>
<li><p>Intersphinx: Added support for fetching Intersphinx inventories with URLs
using HTTP basic auth.</p></li>
<li><p>C++, added support for template parameter in function info field lists.</p></li>
<li><p>C++, added support for pointers to member (function).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2113">#2113</a>: Allow <code class="docutils literal notranslate"><span class="pre">:class:</span></code> option to code-block directive.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2192">#2192</a>: Imgmath (pngmath with svg support).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2200">#2200</a>: Support XeTeX and LuaTeX for the LaTeX builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1906">#1906</a>: Use xcolor over color for fcolorbox where available for LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2216">#2216</a>: Texinputs makefile improvements.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2170">#2170</a>: Support for Chinese language search index.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2214">#2214</a>: Add sphinx.ext.githubpages to publish the docs on GitHub Pages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1030">#1030</a>: Make page reference names for latex_show_pagerefs translatable</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2162">#2162</a>: Add Sphinx.add_source_parser() to add source_suffix and source_parsers
from extension</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2207">#2207</a>: Add sphinx.parsers.Parser class; a base class for new parsers</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/656">#656</a>: Add <code class="docutils literal notranslate"><span class="pre">graphviz_dot</span></code> option to graphviz directives to switch the <code class="docutils literal notranslate"><span class="pre">dot</span></code>
command</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1939">#1939</a>: Added the <code class="docutils literal notranslate"><span class="pre">dummy</span></code> builder: syntax check without output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2230">#2230</a>: Add <code class="docutils literal notranslate"><span class="pre">math_number_all</span></code> option to number all displayed math in math
extensions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2235">#2235</a>: <code class="docutils literal notranslate"><span class="pre">needs_sphinx</span></code> supports micro version comparison</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2282">#2282</a>: Add “language” attribute to html tag in the “basic” theme</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1779">#1779</a>: Add EPUB 3 builder</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1751">#1751</a>: Add <a class="reference internal" href="usage/extensions/todo.html#confval-todo_link_only"><code class="xref std std-confval docutils literal notranslate"><span class="pre">todo_link_only</span></code></a> to avoid file path and line indication on
<a class="reference internal" href="usage/extensions/todo.html#directive-todolist" title="todolist directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">todolist</span></code></a>. Thanks to Francesco Montesano.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2199">#2199</a>: Use <code class="docutils literal notranslate"><span class="pre">imagesize</span></code> package to obtain size of images.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1099">#1099</a>: Add configurable retries to the linkcheck builder. Thanks to Alex
Gaynor. Also don’t check anchors starting with <code class="docutils literal notranslate"><span class="pre">!</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2300">#2300</a>: enhance autoclass:: to use the docstring of __new__ if __init__
method’s is missing of empty</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1858">#1858</a>: Add Sphinx.add_enumerable_node() to add enumerable nodes for numfig
feature</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1286">#1286</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2099">#2099</a>: Add <code class="docutils literal notranslate"><span class="pre">sphinx.ext.autosectionlabel</span></code> extension to allow reference
sections using its title. Thanks to Tadhg O’Higgins.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1854">#1854</a>: Allow to choose Janome for Japanese splitter.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1853">#1853</a>: support custom text splitter on html search with <code class="docutils literal notranslate"><span class="pre">language='ja'</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2320">#2320</a>: classifier of glossary terms can be used for index entries grouping key
The classifier also be used for translation. See also
<a class="reference internal" href="usage/restructuredtext/directives.html#glossary-directive"><span class="std std-ref">Glossary</span></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2308">#2308</a>: Define <code class="docutils literal notranslate"><span class="pre">\tablecontinued</span></code> macro to redefine the style of continued
label for longtables.</p></li>
<li><p>Select an image by similarity if multiple images are globbed by
<code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">image::</span> <span class="pre">filename.*</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1921">#1921</a>: Support figure substitutions by <a class="reference internal" href="usage/configuration.html#confval-language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">language</span></code></a> and
<a class="reference internal" href="usage/configuration.html#confval-figure_language_filename"><code class="xref std std-confval docutils literal notranslate"><span class="pre">figure_language_filename</span></code></a></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2245">#2245</a>: Add <code class="docutils literal notranslate"><span class="pre">latex_elements["passoptionstopackages"]</span></code> option to call
PassOptionsToPackages in early stage of preambles.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2340">#2340</a>: Math extension: support alignment of multiple equations for MathJax.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2338">#2338</a>: Define <code class="docutils literal notranslate"><span class="pre">\titleref</span></code> macro to redefine the style of <code class="docutils literal notranslate"><span class="pre">title-reference</span></code>
roles.</p></li>
<li><p>Define <code class="docutils literal notranslate"><span class="pre">\menuselection</span></code> and <code class="docutils literal notranslate"><span class="pre">\accelerator</span></code> macros to redefine the style of
<a class="reference internal" href="usage/restructuredtext/roles.html#role-menuselection" title="menuselection role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">menuselection</span></code></a> roles.</p></li>
<li><p>Define <code class="docutils literal notranslate"><span class="pre">\crossref</span></code> macro to redefine the style of references</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2301">#2301</a>: Texts in the classic html theme should be hyphenated.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2355">#2355</a>: Define <code class="docutils literal notranslate"><span class="pre">\termref</span></code> macro to redefine the style of <code class="docutils literal notranslate"><span class="pre">term</span></code> roles.</p></li>
<li><p>Add <a class="reference internal" href="usage/configuration.html#confval-suppress_warnings"><code class="xref std std-confval docutils literal notranslate"><span class="pre">suppress_warnings</span></code></a> to suppress arbitrary warning message
(experimental)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2229">#2229</a>: Fix no warning is given for unknown options</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2327">#2327</a>: Add <a class="reference internal" href="usage/configuration.html#confval-latex_toplevel_sectioning"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_toplevel_sectioning</span></code></a> to switch the top level sectioning of
LaTeX document.</p></li>
</ul>
</section>
<section id="id2519">
<h3>Bugs fixed<a class="headerlink" href="#id2519" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1913">#1913</a>: C++, fix assert bug for enumerators in next-to-global and global scope.</p></li>
<li><p>C++, fix parsing of ‘signed char’ and ‘unsigned char’ as types.</p></li>
<li><p>C++, add missing support for ‘friend’ functions.</p></li>
<li><p>C++, add missing support for virtual base classes (thanks to Rapptz).</p></li>
<li><p>C++, add support for final classes.</p></li>
<li><p>C++, fix parsing of types prefixed with ‘enum’.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2023">#2023</a>: Dutch search support uses Danish stemming info.</p></li>
<li><p>C++, add support for user-defined literals.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1804">#1804</a>: Now html output wraps overflowed long-line-text in the sidebar. Thanks
to Hassen ben tanfous.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2183">#2183</a>: Fix porterstemmer causes <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">json</span></code> to fail.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1899">#1899</a>: Ensure list is sent to OptParse.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2164">#2164</a>: Fix wrong check for pdftex inside sphinx.sty (for graphicx package
option).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2165">#2165</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2218">#2218</a>: Remove faulty and non-need conditional from sphinx.sty.</p></li>
<li><p>Fix broken LaTeX code is generated if unknown language is given</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1944">#1944</a>: Fix rst_prolog breaks file-wide metadata</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2074">#2074</a>: make gettext should use canonical relative paths for .pot. Thanks to
anatoly techtonik.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2311">#2311</a>: Fix sphinx.ext.inheritance_diagram raises AttributeError</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2251">#2251</a>: Line breaks in .rst files are transferred to .pot files in a wrong way.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/794">#794</a>: Fix date formatting in latex output is not localized</p></li>
<li><p>Remove <code class="docutils literal notranslate"><span class="pre">image/gif</span></code> from supported_image_types of LaTeX writer (<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2272">#2272</a>)</p></li>
<li><p>Fix ValueError is raised if LANGUAGE is empty string</p></li>
<li><p>Fix unpack warning is shown when the directives generated from
<code class="docutils literal notranslate"><span class="pre">Sphinx.add_crossref_type</span></code> is used</p></li>
<li><p>The default highlight language is now <code class="docutils literal notranslate"><span class="pre">default</span></code>. 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 <code class="docutils literal notranslate"><span class="pre">highlight_language</span> <span class="pre">=</span> <span class="pre">"python"</span></code>
to conf.py.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2329">#2329</a>: Refresh environment forcedly if source directory has changed.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2331">#2331</a>: Fix code-blocks are filled by block in dvi; remove <code class="docutils literal notranslate"><span class="pre">xcdraw</span></code> option
from xcolor package</p></li>
<li><p>Fix the confval type checker emits warnings if unicode is given to confvals
which expects string value</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2360">#2360</a>: Fix numref in LaTeX output is broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2361">#2361</a>: Fix additional paragraphs inside the “compound” directive are indented</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2364">#2364</a>: Fix KeyError ‘rootSymbol’ on Sphinx upgrade from older version.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2348">#2348</a>: Move amsmath and amssymb to before fontpkg on LaTeX writer.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2368">#2368</a>: Ignore emacs lock files like <code class="docutils literal notranslate"><span class="pre">.#foo.rst</span></code> by default.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2262">#2262</a>: literal_block and its caption has been separated by pagebreak in LaTeX
output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2319">#2319</a>: Fix table counter is overridden by code-block’s in LaTeX. Thanks to
jfbu.</p></li>
<li><p>Fix unpack warning if combined with 3rd party domain extensions.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1153">#1153</a>: Fix figures in sidebar causes latex build error.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2358">#2358</a>: Fix user-preamble could not override the tocdepth definition.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2358">#2358</a>: Reduce tocdepth if <code class="docutils literal notranslate"><span class="pre">part</span></code> or <code class="docutils literal notranslate"><span class="pre">chapter</span></code> is used for top_sectionlevel</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2351">#2351</a>: Fix footnote spacing</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2363">#2363</a>: Fix <code class="docutils literal notranslate"><span class="pre">toctree()</span></code> in templates generates broken links in
SingleHTMLBuilder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2366">#2366</a>: Fix empty hyperref is generated on toctree in HTML builder.</p></li>
</ul>
</section>
<section id="id2549">
<h3>Documentation<a class="headerlink" href="#id2549" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1757">#1757</a>: Fix for usage of <a class="reference internal" href="usage/configuration.html#confval-html_last_updated_fmt"><code class="xref std std-confval docutils literal notranslate"><span class="pre">html_last_updated_fmt</span></code></a>. Thanks to Ralf
Hemmecke.</p></li>
</ul>
</section>
</section>
<section id="release-1-3-6-released-feb-29-2016">
<h2>Release 1.3.6 (released Feb 29, 2016)<a class="headerlink" href="#release-1-3-6-released-feb-29-2016" title="Link to this heading">¶</a></h2>
<section id="id2551">
<h3>Features added<a class="headerlink" href="#id2551" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1873">#1873</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1876">#1876</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2278">#2278</a>: Add <code class="docutils literal notranslate"><span class="pre">page_source_suffix</span></code> html context variable. This
should be introduced with <a class="reference internal" href="usage/configuration.html#confval-source_parsers"><code class="xref std std-confval docutils literal notranslate"><span class="pre">source_parsers</span></code></a> feature. Thanks for Eric
Holscher.</p></li>
</ul>
</section>
<section id="id2555">
<h3>Bugs fixed<a class="headerlink" href="#id2555" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2265">#2265</a>: Fix babel is used in spite of disabling it on <code class="docutils literal notranslate"><span class="pre">latex_elements</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2295">#2295</a>: Avoid mutating dictionary errors while enumerating members in autodoc
with Python 3</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2291">#2291</a>: Fix pdflatex “Counter too large” error from footnotes inside tables of
contents</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2292">#2292</a>: Fix some footnotes disappear from LaTeX output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2287">#2287</a>: <code class="docutils literal notranslate"><span class="pre">sphinx.transforms.Locale</span></code> always uses rst parser. Sphinx i18n
feature should support parsers that specified source_parsers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2290">#2290</a>: Fix <code class="docutils literal notranslate"><span class="pre">sphinx.ext.mathbase</span></code> use of amsfonts may break user choice of
math fonts</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2324">#2324</a>: Print a hint how to increase the recursion limit when it is hit.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1565">#1565</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2229">#2229</a>: Revert new warning; the new warning will be triggered from
version 1.4 on.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2329">#2329</a>: Refresh environment forcedly if source directory has changed.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2019">#2019</a>: Fix the domain objects in search result are not escaped</p></li>
</ul>
</section>
</section>
<section id="release-1-3-5-released-jan-24-2016">
<h2>Release 1.3.5 (released Jan 24, 2016)<a class="headerlink" href="#release-1-3-5-released-jan-24-2016" title="Link to this heading">¶</a></h2>
<section id="id2567">
<h3>Bugs fixed<a class="headerlink" href="#id2567" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Fix line numbers was not shown on warnings in LaTeX and texinfo builders</p></li>
<li><p>Fix filenames were not shown on warnings of citations</p></li>
<li><p>Fix line numbers was not shown on warnings in LaTeX and texinfo builders</p></li>
<li><p>Fix line numbers was not shown on warnings of indices</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2026">#2026</a>: Fix LaTeX builder raises error if parsed-literal includes links</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2243">#2243</a>: Ignore strange docstring types for classes, do not crash</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2247">#2247</a>: Fix <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2205">#2205</a> breaks make html for definition list with classifiers
that contains regular-expression like string</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1565">#1565</a>: Sphinx will now emit a warning that highlighting was skipped if the
syntax is incorrect for <a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a>, <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> and so on.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2211">#2211</a>: Fix paragraphs in table cell doesn’t work in Latex output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2253">#2253</a>: <code class="docutils literal notranslate"><span class="pre">:pyobject:</span></code> option of <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> directive can’t detect
indented body block when the block starts with blank or comment lines.</p></li>
<li><p>Fix TOC is not shown when no <code class="docutils literal notranslate"><span class="pre">:maxdepth:</span></code> for toctrees (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/771">#771</a>)</p></li>
<li><p>Fix warning message for <code class="docutils literal notranslate"><span class="pre">:numref:</span></code> if target is in orphaned doc (ref: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2244">#2244</a>)</p></li>
</ul>
</section>
</section>
<section id="release-1-3-4-released-jan-12-2016">
<h2>Release 1.3.4 (released Jan 12, 2016)<a class="headerlink" href="#release-1-3-4-released-jan-12-2016" title="Link to this heading">¶</a></h2>
<section id="id2577">
<h3>Bugs fixed<a class="headerlink" href="#id2577" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2134">#2134</a>: Fix figure caption with reference causes latex build error</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2094">#2094</a>: Fix rubric with reference not working in Latex</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2147">#2147</a>: Fix literalinclude code in latex does not break in pages</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1833">#1833</a>: Fix email addresses is showed again if latex_show_urls is not None</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2176">#2176</a>: sphinx.ext.graphviz: use <object> instead of <img> to embed svg</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/967">#967</a>: Fix SVG inheritance diagram is not hyperlinked (clickable)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1237">#1237</a>: Fix footnotes not working in definition list in LaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2168">#2168</a>: Fix raw directive does not work for text writer</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2171">#2171</a>: Fix cannot linkcheck url with unicode</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2182">#2182</a>: LaTeX: support image file names with more than 1 dots</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2189">#2189</a>: Fix previous sibling link for first file in subdirectory uses last
file, not intended previous from root toctree</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2003">#2003</a>: Fix decode error under python2 (only) when <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">linkcheck</span></code> is run</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2186">#2186</a>: Fix LaTeX output of mathbb in math</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1480">#1480</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2188">#2188</a>: LaTeX: Support math in section titles</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2071">#2071</a>: Fix same footnote in more than two section titles => LaTeX/PDF Bug</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2040">#2040</a>: Fix UnicodeDecodeError in sphinx-apidoc when author contains non-ascii
characters</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2193">#2193</a>: Fix shutil.SameFileError if source directory and destination directory
are same</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2178">#2178</a>: Fix unparsable C++ cross-reference when referencing a function with
:cpp:any:</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2206">#2206</a>: Fix Sphinx latex doc build failed due to a footnotes</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2201">#2201</a>: Fix wrong table caption for tables with over 30 rows</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2213">#2213</a>: Set <blockquote> in the classic theme to fit with <p></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1815">#1815</a>: Fix linkcheck does not raise an exception if warniserror set to true
and link is broken</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2197">#2197</a>: Fix slightly cryptic error message for missing index.rst file</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1894">#1894</a>: Unlisted phony targets in quickstart Makefile</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2125">#2125</a>: Fix unifies behavior of collapsed fields (<code class="docutils literal notranslate"><span class="pre">GroupedField</span></code> and
<code class="docutils literal notranslate"><span class="pre">TypedField</span></code>)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1408">#1408</a>: Check latex_logo validity before copying</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/771">#771</a>: Fix latex output doesn’t set tocdepth</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1820">#1820</a>: On Windows, console coloring is broken with colorama version 0.3.3.
Now sphinx use colorama>=0.3.5 to avoid this problem.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2072">#2072</a>: Fix footnotes in chapter-titles do not appear in PDF output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1580">#1580</a>: Fix paragraphs in longtable don’t work in Latex output</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1366">#1366</a>: Fix centered image not centered in latex</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1860">#1860</a>: Fix man page using <code class="docutils literal notranslate"><span class="pre">:samp:</span></code> with braces - font doesn’t reset</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1610">#1610</a>: Sphinx crashes in Japanese indexing in some systems</p></li>
<li><p>Fix Sphinx crashes if mecab initialization failed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2160">#2160</a>: Fix broken TOC of PDFs if section includes an image</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2172">#2172</a>: Fix dysfunctional admonition <code class="docutils literal notranslate"><span class="pre">\py@lightbox</span></code> in sphinx.sty. Thanks to
jfbu.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2198">#2198</a>,`#2205 <<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2205">https://github.com/sphinx-doc/sphinx/issues/2205</a>>`_: <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">gettext</span></code> generate broken msgid for definition lists.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2062">#2062</a>: Escape characters in doctests are treated incorrectly with Python 2.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2225">#2225</a>: Fix if the option does not begin with dash, linking is not performed</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2226">#2226</a>: Fix math is not HTML-encoded when :nowrap: is given (jsmath, mathjax)</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1601">#1601</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2220">#2220</a>: ‘any’ role breaks extended domains behavior. Affected extensions
doesn’t support resolve_any_xref and resolve_xref returns problematic node
instead of None. sphinxcontrib-httpdomain is one of them.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2229">#2229</a>: Fix no warning is given for unknown options</p></li>
</ul>
</section>
</section>
<section id="release-1-3-3-released-dec-2-2015">
<h2>Release 1.3.3 (released Dec 2, 2015)<a class="headerlink" href="#release-1-3-3-released-dec-2-2015" title="Link to this heading">¶</a></h2>
<section id="id2621">
<h3>Bugs fixed<a class="headerlink" href="#id2621" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2177">#2177</a>: Fix parallel hangs</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2012">#2012</a>: Fix exception occurred if <code class="docutils literal notranslate"><span class="pre">numfig_format</span></code> is invalid</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2142">#2142</a>: Provide non-minified JS code in <code class="docutils literal notranslate"><span class="pre">sphinx/search/non-minified-js/*.js</span></code>
for source distribution on PyPI.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2148">#2148</a>: Error while building devhelp target with non-ASCII document.</p></li>
</ul>
</section>
</section>
<section id="release-1-3-2-released-nov-29-2015">
<h2>Release 1.3.2 (released Nov 29, 2015)<a class="headerlink" href="#release-1-3-2-released-nov-29-2015" title="Link to this heading">¶</a></h2>
<section id="id2626">
<h3>Features added<a class="headerlink" href="#id2626" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1935">#1935</a>: Make “numfig_format” overridable in latex_elements.</p></li>
</ul>
</section>
<section id="id2628">
<h3>Bugs fixed<a class="headerlink" href="#id2628" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1976">#1976</a>: Avoid “2.0” version of Babel because it doesn’t work with Windows
environment.</p></li>
<li><p>Add a “default.css” stylesheet (which imports “classic.css”) for compatibility</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1788">#1788</a>: graphviz extension raises exception when caption option is present.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1789">#1789</a>: <code class="docutils literal notranslate"><span class="pre">:pyobject:</span></code> option of <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> directive includes
following lines after class definitions</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1790">#1790</a>: <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> strips empty lines at the head and tail</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1802">#1802</a>: load plugin themes automatically when theme.conf use it as ‘inherit’.
Thanks to Takayuki Hirai.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1794">#1794</a>: custom theme extended from alabaster or sphinx_rtd_theme can’t find
base theme.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1834">#1834</a>: compatibility for docutils-0.13: handle_io_errors keyword argument for
docutils.io.FileInput cause TypeError.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1823">#1823</a>: ‘.’ as <module_path> for sphinx-apidoc cause an unfriendly error. Now
‘.’ is converted to absolute path automatically.</p></li>
<li><p>Fix a crash when setting up extensions which do not support metadata.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1784">#1784</a>: Provide non-minified JS code in <code class="docutils literal notranslate"><span class="pre">sphinx/search/non-minified-js/*.js</span></code></p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1822">#1822</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1892">#1892</a>: Fix regression for <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1061">#1061</a>. autosummary can’t generate doc for
imported members since Sphinx 1.3b3. Thanks to Eric Larson.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1793">#1793</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1819">#1819</a>: “see also” misses a linebreak in text output. Thanks to Takayuki
Hirai.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1780">#1780</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1866">#1866</a>: “make text” shows “class” keyword twice. Thanks to Takayuki
Hirai.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1871">#1871</a>: Fix for LaTeX output of tables with one column and multirows.</p></li>
<li><p>Work around the lack of the HTMLParserError exception in Python 3.5.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1949">#1949</a>: Use <code class="docutils literal notranslate"><span class="pre">safe_getattr</span></code> in the coverage builder to avoid aborting with
descriptors that have custom behavior.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1915">#1915</a>: Do not generate smart quotes in doc field type annotations.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1796">#1796</a>: On py3, automated .mo building caused UnicodeDecodeError.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1923">#1923</a>: Use babel features only if the babel latex element is nonempty.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1942">#1942</a>: Fix a KeyError in websupport.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1903">#1903</a>: Fix strange id generation for glossary terms.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">text</span></code> will crush if a definition list item has more than 1 classifiers
as: <code class="docutils literal notranslate"><span class="pre">term</span> <span class="pre">:</span> <span class="pre">classifier1</span> <span class="pre">:</span> <span class="pre">classifier2</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1855">#1855</a>: make gettext generates broken po file for definition lists with
classifier.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1869">#1869</a>: Fix problems when dealing with files containing non-ASCII characters.
Thanks to Marvin Schmidt.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1798">#1798</a>: Fix building LaTeX with references in titles.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1725">#1725</a>: On py2 environment, doctest with using non-ASCII characters causes
<code class="docutils literal notranslate"><span class="pre">'ascii'</span> <span class="pre">codec</span> <span class="pre">can't</span> <span class="pre">decode</span> <span class="pre">byte</span></code> exception.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1540">#1540</a>: Fix RuntimeError with circular referenced toctree</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1983">#1983</a>: i18n translation feature breaks references which uses section name.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1990">#1990</a>: Use caption of toctree to title of tableofcontents in LaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1987">#1987</a>: Fix ampersand is ignored in <code class="docutils literal notranslate"><span class="pre">:menuselection:</span></code> and <code class="docutils literal notranslate"><span class="pre">:guilabel:</span></code>
on LaTeX builder</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1994">#1994</a>: More supporting non-standard parser (like recommonmark parser) for
Translation and WebSupport feature. Now node.rawsource is fall backed to
node.astext() during docutils transforming.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1989">#1989</a>: “make blahblah” on Windows indicate help messages for sphinx-build
every time. It was caused by wrong make.bat that generated by
Sphinx 1.3.0/1.3.1.</p></li>
<li><p>On Py2 environment, conf.py that is generated by sphinx-quickstart should have
u prefixed config value for ‘version’ and ‘release’.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2102">#2102</a>: On Windows + Py3, using <code class="docutils literal notranslate"><span class="pre">|today|</span></code> and non-ASCII date format will
raise UnicodeEncodeError.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1974">#1974</a>: UnboundLocalError: local variable ‘domain’ referenced before assignment
when using <a class="reference internal" href="usage/restructuredtext/roles.html#role-any" title="any role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">any</span></code></a> role and <a class="reference internal" href="usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="sphinx.ext.intersphinx: Link to other Sphinx documentation."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></a> in same time.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2121">#2121</a>: multiple words search doesn’t find pages when words across on the page
title and the page content.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1884">#1884</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1885">#1885</a>: plug-in html themes cannot inherit another plug-in theme. Thanks
to Suzumizaki.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1818">#1818</a>: <a class="reference internal" href="usage/extensions/todo.html#module-sphinx.ext.todo" title="sphinx.ext.todo: Allow inserting todo items into documents."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.todo</span></code></a> directive generates broken html class attribute as
‘admonition-’ when <a class="reference internal" href="usage/configuration.html#confval-language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">language</span></code></a> is specified with non-ASCII linguistic
area like ‘ru’ or ‘ja’. To fix this, now <code class="docutils literal notranslate"><span class="pre">todo</span></code> directive can use
<code class="docutils literal notranslate"><span class="pre">:class:</span></code> option.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2140">#2140</a>: Fix footnotes in table has broken in LaTeX</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/2127">#2127</a>: MecabBinder for html searching feature doesn’t work with Python 3.
Thanks to Tomoko Uchida.</p></li>
</ul>
</section>
</section>
<section id="release-1-3-1-released-mar-17-2015">
<h2>Release 1.3.1 (released Mar 17, 2015)<a class="headerlink" href="#release-1-3-1-released-mar-17-2015" title="Link to this heading">¶</a></h2>
<section id="id2670">
<h3>Bugs fixed<a class="headerlink" href="#id2670" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1769">#1769</a>: allows generating quickstart files/dirs for destination dir that
doesn’t overwrite existent files/dirs. Thanks to WAKAYAMA shirou.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1773">#1773</a>: sphinx-quickstart doesn’t accept non-ASCII character as a option
argument.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1766">#1766</a>: the message “least Python 2.6 to run” is at best misleading.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1772">#1772</a>: cross reference in docstrings like <code class="docutils literal notranslate"><span class="pre">:param</span> <span class="pre">.write:</span></code> breaks building.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1770">#1770</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1774">#1774</a>: <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> with empty file occurs exception. Thanks to
Takayuki Hirai.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1777">#1777</a>: Sphinx 1.3 can’t load extra theme. Thanks to tell-k.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1776">#1776</a>: <code class="docutils literal notranslate"><span class="pre">source_suffix</span> <span class="pre">=</span> <span class="pre">['.rst']</span></code> cause unfriendly error on prior version.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1771">#1771</a>: automated .mo building doesn’t work properly.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1783">#1783</a>: Autodoc: Python2 Allow unicode string in __all__.
Thanks to Jens Hedegaard Nielsen.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1781">#1781</a>: Setting <a class="reference internal" href="usage/configuration.html#confval-html_domain_indices"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_domain_indices</span></code></a> to a list raises a type check warnings.</p></li>
</ul>
</section>
</section>
<section id="release-1-3-released-mar-10-2015">
<h2>Release 1.3 (released Mar 10, 2015)<a class="headerlink" href="#release-1-3-released-mar-10-2015" title="Link to this heading">¶</a></h2>
<section id="id2682">
<h3>Incompatible changes<a class="headerlink" href="#id2682" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Roles <code class="docutils literal notranslate"><span class="pre">ref</span></code>, <code class="docutils literal notranslate"><span class="pre">term</span></code> and <code class="docutils literal notranslate"><span class="pre">menusel</span></code> now don’t generate <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/roles.html#emphasis">emphasis</a>
nodes anymore. If you want to keep italic style, adapt your stylesheet.</p></li>
<li><p>Role <code class="docutils literal notranslate"><span class="pre">numref</span></code> uses <code class="docutils literal notranslate"><span class="pre">%s</span></code> as special character to indicate position of
figure numbers instead <code class="docutils literal notranslate"><span class="pre">#</span></code> symbol.</p></li>
</ul>
</section>
<section id="id2683">
<h3>Features added<a class="headerlink" href="#id2683" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Add convenience directives and roles to the C++ domain:
directive <code class="docutils literal notranslate"><span class="pre">cpp:var</span></code> as alias for <code class="docutils literal notranslate"><span class="pre">cpp:member</span></code>, role <code class="docutils literal notranslate"><span class="pre">:cpp:var</span></code> as alias
for <code class="docutils literal notranslate"><span class="pre">:cpp:member</span></code>, and role <a class="reference internal" href="usage/restructuredtext/roles.html#role-any" title="any role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">any</span></code></a> for cross-reference to any C++
declaraction. <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1577">#1577</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1744">#1744</a></p></li>
<li><p>The <a class="reference internal" href="usage/configuration.html#confval-source_suffix"><code class="xref std std-confval docutils literal notranslate"><span class="pre">source_suffix</span></code></a> config value can now be a list of multiple
suffixes.</p></li>
<li><p>Add the ability to specify source parsers by source suffix with the
<a class="reference internal" href="usage/configuration.html#confval-source_parsers"><code class="xref std std-confval docutils literal notranslate"><span class="pre">source_parsers</span></code></a> config value.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1675">#1675</a>: A new builder, AppleHelpBuilder, has been added that builds Apple
Help Books.</p></li>
</ul>
</section>
<section id="id2687">
<h3>Bugs fixed<a class="headerlink" href="#id2687" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>1.3b3 change breaks a previous gettext output that contains duplicated
msgid such as “foo bar” and “version changes in 1.3: foo bar”.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1745">#1745</a>: latex builder cause maximum recursion depth exceeded when a
footnote has a footnote mark itself.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1748">#1748</a>: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1658">#1658</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1750">#1750</a>: No link created (and warning given) if option does not
begin with -, / or +. Thanks to Takayuki Hirai.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1753">#1753</a>: C++, added missing support for more complex declarations.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1700">#1700</a>: Add <code class="docutils literal notranslate"><span class="pre">:caption:</span></code> option for <a class="reference internal" href="usage/restructuredtext/directives.html#directive-toctree" title="toctree directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">toctree</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1742">#1742</a>: <code class="docutils literal notranslate"><span class="pre">:name:</span></code> option is provided for <a class="reference internal" href="usage/restructuredtext/directives.html#directive-toctree" title="toctree directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">toctree</span></code></a>,
<a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a> and <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1756">#1756</a>: Incorrect section titles in search that was introduced from 1.3b3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1746">#1746</a>: C++, fixed name lookup procedure, and added missing lookups in
declarations.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1765">#1765</a>: C++, fix old id generation to use fully qualified names.</p></li>
</ul>
</section>
<section id="id2698">
<h3>Documentation<a class="headerlink" href="#id2698" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1651">#1651</a>: Add <code class="docutils literal notranslate"><span class="pre">vartype</span></code> field description for python domain.</p></li>
</ul>
</section>
</section>
<section id="release-1-3b3-released-feb-24-2015">
<h2>Release 1.3b3 (released Feb 24, 2015)<a class="headerlink" href="#release-1-3b3-released-feb-24-2015" title="Link to this heading">¶</a></h2>
<section id="id2700">
<h3>Incompatible changes<a class="headerlink" href="#id2700" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Dependency requirement updates: docutils 0.11, Pygments 2.0</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">gettext_enables</span></code> config value has been renamed to
<a class="reference internal" href="usage/configuration.html#confval-gettext_additional_targets"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">gettext_additional_targets</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1735">#1735</a>: Use <a class="reference external" href="https://docs.python.org/">https://docs.python.org/</a> instead of <code class="docutils literal notranslate"><span class="pre">http</span></code> protocol.
It was used for <a class="reference internal" href="usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="sphinx.ext.intersphinx: Link to other Sphinx documentation."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></a> and some documentation.</p></li>
</ul>
</section>
<section id="id2702">
<h3>Features added<a class="headerlink" href="#id2702" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1346">#1346</a>: Add new default theme;</p>
<ul>
<li><p>Add ‘alabaster’ theme.</p></li>
<li><p>Add ‘sphinx_rtd_theme’ theme.</p></li>
<li><p>The ‘default’ html theme has been renamed to ‘classic’. ‘default’ is still
available, however it will emit notice a recommendation that using new
‘alabaster’ theme.</p></li>
</ul>
</li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">highlight_options</span></code> configuration value.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">language</span></code> config value is now available in the HTML templates.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">env-updated</span></code> event can now return a value, which is interpreted
as an iterable of additional docnames that need to be rewritten.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/772">#772</a>: Support for scoped and unscoped enums in C++. Enumerators in unscoped
enums are injected into the parent scope in addition to the enum scope.</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">todo_include_todos</span></code> config option to quickstart conf file, handled as
described in documentation.</p></li>
<li><p>HTML breadcrumb items tag has class “nav-item” and “nav-item-N” (like
nav-item-0, 1, 2…).</p></li>
<li><p>New option <a class="reference internal" href="man/sphinx-quickstart.html#cmdoption-sphinx-quickstart-use-make-mode"><code class="xref any std std-option docutils literal notranslate"><span class="pre">sphinx-quickstart</span> <span class="pre">--use-make-mode</span></code></a> for generating Makefile that
use sphinx-build make-mode.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1235">#1235</a>: i18n: several node can be translated if it is set to
<a class="reference internal" href="usage/configuration.html#confval-gettext_additional_targets"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">gettext_additional_targets</span></code></a> in conf.py. Supported nodes are:</p>
<ul>
<li><p>‘literal-block’</p></li>
<li><p>‘doctest-block’</p></li>
<li><p>‘raw’</p></li>
<li><p>‘image’</p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1227">#1227</a>: Add <a class="reference internal" href="usage/configuration.html#confval-html_scaled_image_link"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_scaled_image_link</span></code></a> config option to conf.py, to control
scaled image link.</p></li>
</ul>
</section>
<section id="id2707">
<h3>Bugs fixed<a class="headerlink" href="#id2707" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>LaTeX writer now generates correct markup for cells spanning multiple rows.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1674">#1674</a>: Do not crash if a module’s <code class="docutils literal notranslate"><span class="pre">__all__</span></code> is not a list of strings.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1629">#1629</a>: Use VerbatimBorderColor to add frame to code-block in LaTeX</p></li>
<li><p>On windows, make-mode didn’t work on Win32 platform if sphinx was invoked as
<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">sphinx-build.py</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1687">#1687</a>: linkcheck now treats 401 Unauthorized responses as “working”.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1690">#1690</a>: toctrees with <code class="docutils literal notranslate"><span class="pre">glob</span></code> option now can also contain entries for single
documents with explicit title.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1591">#1591</a>: html search results for C++ elements now has correct interpage links.</p></li>
<li><p>bizstyle theme: nested long title pages make long breadcrumb that breaks page
layout.</p></li>
<li><p>bizstyle theme: all breadcrumb items become ‘Top’ on some mobile browser
(iPhone5s safari).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1722">#1722</a>: restore <code class="docutils literal notranslate"><span class="pre">toctree()</span></code> template function behavior that was changed at
1.3b1.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1732">#1732</a>: i18n: localized table caption raises exception.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1718">#1718</a>: <code class="docutils literal notranslate"><span class="pre">:numref:</span></code> does not work with capital letters in the label</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1630">#1630</a>: resolve CSS conflicts, <code class="docutils literal notranslate"><span class="pre">div.container</span></code> css target for literal block
wrapper now renamed to <code class="docutils literal notranslate"><span class="pre">div.literal-block-wrapper</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.util.pycompat</span></code> has been restored in its backwards-compatibility;
slated for removal in Sphinx 1.4.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1719">#1719</a>: LaTeX writer does not respect <code class="docutils literal notranslate"><span class="pre">numref_format</span></code> option in captions</p></li>
</ul>
</section>
</section>
<section id="release-1-3b2-released-dec-5-2014">
<h2>Release 1.3b2 (released Dec 5, 2014)<a class="headerlink" href="#release-1-3b2-released-dec-5-2014" title="Link to this heading">¶</a></h2>
<section id="id2718">
<h3>Incompatible changes<a class="headerlink" href="#id2718" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>update bundled ez_setup.py for setuptools-7.0 that requires Python 2.6 or
later.</p></li>
</ul>
</section>
<section id="id2719">
<h3>Features added<a class="headerlink" href="#id2719" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1597">#1597</a>: Added possibility to return a new template name from
<a class="reference internal" href="extdev/appapi.html#event-html-page-context"><code class="xref any std std-event docutils literal notranslate"><span class="pre">html-page-context</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/314">PR#314</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1150">#1150</a>: Configuration values are now checked for their type. A
warning is raised if the configured and the default value do not have the
same type and do not share a common non-trivial base class.</p></li>
</ul>
</section>
<section id="id2722">
<h3>Bugs fixed<a class="headerlink" href="#id2722" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/311">PR#311</a>: sphinx-quickstart does not work on python 3.4.</p></li>
<li><p>Fix <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_docstring_signature"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_docstring_signature</span></code></a> not working with signatures
in class docstrings.</p></li>
<li><p>Rebuilding cause crash unexpectedly when source files were added.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1607">#1607</a>: Fix a crash when building latexpdf with “howto” class</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1251">#1251</a>: Fix again. Sections which depth are lower than :tocdepth: should not
be shown on localtoc sidebar.</p></li>
<li><p>make-mode didn’t work on Win32 platform if sphinx was installed by wheel
package.</p></li>
</ul>
</section>
</section>
<section id="release-1-3b1-released-oct-10-2014">
<h2>Release 1.3b1 (released Oct 10, 2014)<a class="headerlink" href="#release-1-3b1-released-oct-10-2014" title="Link to this heading">¶</a></h2>
<section id="id2725">
<h3>Incompatible changes<a class="headerlink" href="#id2725" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Dropped support for Python 2.5, 3.1 and 3.2.</p></li>
<li><p>Dropped support for docutils versions up to 0.9.</p></li>
<li><p>Removed the <code class="docutils literal notranslate"><span class="pre">sphinx.ext.oldcmarkup</span></code> extension.</p></li>
<li><p>The deprecated config values <code class="docutils literal notranslate"><span class="pre">exclude_trees</span></code>, <code class="docutils literal notranslate"><span class="pre">exclude_dirnames</span></code> and
<code class="docutils literal notranslate"><span class="pre">unused_docs</span></code> have been removed.</p></li>
<li><p>A new node, <code class="docutils literal notranslate"><span class="pre">sphinx.addnodes.literal_strong</span></code>, has been added, for text that
should appear literally (i.e. no smart quotes) in strong font. Custom writers
will have to be adapted to handle this node.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/269">PR#269</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1476">#1476</a>: replace <code class="docutils literal notranslate"><span class="pre"><tt></span></code> tag by <code class="docutils literal notranslate"><span class="pre"><code></span></code>. User customized stylesheets
should be updated If the css contain some styles for <code class="docutils literal notranslate"><span class="pre">tt></span></code> tag.
Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1543">#1543</a>: <a class="reference internal" href="usage/configuration.html#confval-templates_path"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">templates_path</span></code></a> is automatically added to
<a class="reference internal" href="usage/configuration.html#confval-exclude_patterns"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">exclude_patterns</span></code></a> to avoid reading autosummary rst templates in the
templates directory.</p></li>
<li><p>Custom domains should implement the new <a class="reference internal" href="extdev/domainapi.html#sphinx.domains.Domain.resolve_any_xref" title="sphinx.domains.Domain.resolve_any_xref"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">Domain.resolve_any_xref</span></code></a>
method to make the <a class="reference internal" href="usage/restructuredtext/roles.html#role-any" title="any role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">any</span></code></a> role work properly.</p></li>
<li><p>gettext builder: gettext doesn’t emit uuid information to generated pot files
by default. Please set <code class="docutils literal notranslate"><span class="pre">True</span></code> to <a class="reference internal" href="usage/configuration.html#confval-gettext_uuid"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">gettext_uuid</span></code></a> to emit uuid information.
Additionally, if the <code class="docutils literal notranslate"><span class="pre">python-levenshtein</span></code> 3rd-party package is installed,
it will improve the calculation time.</p></li>
<li><p>gettext builder: disable extracting/apply ‘index’ node by default. Please set
‘index’ to <code class="docutils literal notranslate"><span class="pre">gettext_enables</span></code> to enable extracting index entries.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/307">PR#307</a>: Add frame to code-block in LaTeX. Thanks to Takeshi Komiya.</p></li>
</ul>
</section>
<section id="id2728">
<h3>Features added<a class="headerlink" href="#id2728" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Add support for Python 3.4.</p></li>
<li><p>Add support for docutils 0.12</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">sphinx.ext.napoleon</span></code> extension for NumPy and Google style docstring
support.</p></li>
<li><p>Added support for parallel reading (parsing) of source files with the
<a class="reference internal" href="man/sphinx-build.html#cmdoption-sphinx-build-j"><code class="xref any std std-option docutils literal notranslate"><span class="pre">sphinx-build</span> <span class="pre">-j</span></code></a> option. Third-party extensions will need to be checked for
compatibility and may need to be adapted if they store information in the
build environment object. See <a class="reference internal" href="extdev/appapi.html#event-env-merge-info"><code class="xref any std std-event docutils literal notranslate"><span class="pre">env-merge-info</span></code></a>.</p></li>
<li><p>Added the <a class="reference internal" href="usage/restructuredtext/roles.html#role-any" title="any role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">any</span></code></a> role that can be used to find a cross-reference of
<em>any</em> type in <em>any</em> domain. Custom domains should implement the new
<a class="reference internal" href="extdev/domainapi.html#sphinx.domains.Domain.resolve_any_xref" title="sphinx.domains.Domain.resolve_any_xref"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">Domain.resolve_any_xref</span></code></a> method to make this work properly.</p></li>
<li><p>Exception logs now contain the last 10 messages emitted by Sphinx.</p></li>
<li><p>Added support for extension versions (a string returned by <code class="docutils literal notranslate"><span class="pre">setup()</span></code>, these
can be shown in the traceback log files). Version requirements for extensions
can be specified in projects using the new <a class="reference internal" href="usage/configuration.html#confval-needs_extensions"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">needs_extensions</span></code></a> config
value.</p></li>
<li><p>Changing the default role within a document with the <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#default-role">default-role</a>
directive is now supported.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/214">PR#214</a>: Added stemming support for 14 languages, so that the built-in document
search can now handle these. Thanks to Shibukawa Yoshiki.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/296">PR#296</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/303">PR#303</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/76">#76</a>: numfig feature: Assign numbers to figures, tables and
code-blocks. This feature is configured with <a class="reference internal" href="usage/configuration.html#confval-numfig"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">numfig</span></code></a>, <a class="reference internal" href="usage/configuration.html#confval-numfig_secnum_depth"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">numfig_secnum_depth</span></code></a>
and <a class="reference internal" href="usage/configuration.html#confval-numfig_format"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">numfig_format</span></code></a>. Also <a class="reference internal" href="usage/restructuredtext/roles.html#role-numref" title="numref role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">numref</span></code></a> role is available. Thanks to Takeshi
Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/202">PR#202</a>: Allow “.” and “~” prefixed references in <code class="docutils literal notranslate"><span class="pre">:param:</span></code> doc fields
for Python.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/184">PR#184</a>: Add <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_mock_imports"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">autodoc_mock_imports</span></code></a>, allowing to mock imports of
external modules that need not be present when autodocumenting.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/925">#925</a>: Allow list-typed config values to be provided on the command line,
like <code class="docutils literal notranslate"><span class="pre">-D</span> <span class="pre">key=val1,val2</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/668">#668</a>: Allow line numbering of <a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a> and <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> directives
to start at an arbitrary line number, with a new <code class="docutils literal notranslate"><span class="pre">lineno-start</span></code> option.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/172">PR#172</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/266">PR#266</a>: The <a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a> and <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a>
directives now can have a <code class="docutils literal notranslate"><span class="pre">caption</span></code> option that shows a filename before the
code in the output. Thanks to Nasimul Haque, Takeshi Komiya.</p></li>
<li><p>Prompt for the document language in sphinx-quickstart.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/217">PR#217</a>: Added config values to suppress UUID and location information in
generated gettext catalogs.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/236">PR#236</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1456">#1456</a>: apidoc: Add a -M option to put module documentation before
submodule documentation. Thanks to Wes Turner and Luc Saffre.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1434">#1434</a>: Provide non-minified JS files for jquery.js and underscore.js to
clarify the source of the minified files.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/252">PR#252</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1291">#1291</a>: Windows color console support. Thanks to meu31.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/255">PR#255</a>: When generating latex references, also insert latex target/anchor
for the ids defined on the node. Thanks to Olivier Heurtier.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/229">PR#229</a>: Allow registration of other translators. Thanks to Russell Sim.</p></li>
<li><p>Add app.set_translator() API to register or override a Docutils translator
class like <code class="docutils literal notranslate"><span class="pre">html_translator_class</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/267">PR#267</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1134">#1134</a>: add ‘diff’ parameter to literalinclude. Thanks to Richard Wall
and WAKAYAMA shirou.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/272">PR#272</a>: Added ‘bizstyle’ theme. Thanks to Shoji KUMAGAI.</p></li>
<li><p>Automatically compile <code class="docutils literal notranslate"><span class="pre">*.mo</span></code> files from <code class="docutils literal notranslate"><span class="pre">*.po</span></code> files when
<a class="reference internal" href="usage/configuration.html#confval-gettext_auto_build"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">gettext_auto_build</span></code></a> is True (default) and <code class="docutils literal notranslate"><span class="pre">*.po</span></code> is newer than
<code class="docutils literal notranslate"><span class="pre">*.mo</span></code> file.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/623">#623</a>: <a class="reference internal" href="usage/extensions/viewcode.html#module-sphinx.ext.viewcode" title="sphinx.ext.viewcode: Add links to a highlighted version of the source code."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.viewcode</span></code></a> supports imported function/class aliases.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/275">PR#275</a>: <a class="reference internal" href="usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="sphinx.ext.intersphinx: Link to other Sphinx documentation."><code class="xref any py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code></a> supports multiple target for the
inventory. Thanks to Brigitta Sipocz.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/261">PR#261</a>: Added the <a class="reference internal" href="extdev/appapi.html#event-env-before-read-docs"><code class="xref any std std-event docutils literal notranslate"><span class="pre">env-before-read-docs</span></code></a> event that can be connected to modify
the order of documents before they are read by the environment.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1284">#1284</a>: Program options documented with <a class="reference internal" href="usage/restructuredtext/domains.html#directive-option" title="option directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">option</span></code></a> can now start with
<code class="docutils literal notranslate"><span class="pre">+</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/291">PR#291</a>: The caption of <a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a> is recognized as a title of ref
target. Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/298">PR#298</a>: Add new API: <a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.add_latex_package" title="sphinx.application.Sphinx.add_latex_package"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_latex_package()</span></code></a>.
Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1344">#1344</a>: add <code class="docutils literal notranslate"><span class="pre">gettext_enables</span></code> to enable extracting ‘index’ to gettext
catalog output / applying translation catalog to generated documentation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/301">PR#301</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1583">#1583</a>: Allow the line numbering of the directive <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> to
match that of the included file, using a new <code class="docutils literal notranslate"><span class="pre">lineno-match</span></code> option. Thanks
to Jeppe Pihl.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/299">PR#299</a>: add various options to sphinx-quickstart. Quiet mode option
<code class="docutils literal notranslate"><span class="pre">--quiet</span></code> will skips wizard mode. Thanks to WAKAYAMA shirou.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1623">#1623</a>: Return types specified with <code class="docutils literal notranslate"><span class="pre">:rtype:</span></code> are now turned into links if
possible.</p></li>
</ul>
</section>
<section id="id2741">
<h3>Bugs fixed<a class="headerlink" href="#id2741" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1438">#1438</a>: Updated jQuery version from 1.8.3 to 1.11.1.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1568">#1568</a>: Fix a crash when a “centered” directive contains a reference.</p></li>
<li><p>Now sphinx.ext.autodoc works with python-2.5 again.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1563">#1563</a>: <a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.add_search_language" title="sphinx.application.Sphinx.add_search_language"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_search_language()</span></code></a> raises
AssertionError for correct type of argument. Thanks to rikoman.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1174">#1174</a>: Fix smart quotes being applied inside roles like <a class="reference internal" href="usage/restructuredtext/roles.html#role-program" title="program role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">program</span></code></a> or
<a class="reference internal" href="usage/restructuredtext/roles.html#role-makevar" title="makevar role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">makevar</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/235">PR#235</a>: comment db schema of websupport lacked a length of the node_id field.
Thanks to solos.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1466">#1466</a>,`PR#241 <<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/241">https://github.com/sphinx-doc/sphinx/issues/241</a>>`_: Fix failure of the cpp domain parser to parse C+11
“variadic templates” declarations. Thanks to Victor Zverovich.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1459">#1459</a>,`PR#244 <<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/244">https://github.com/sphinx-doc/sphinx/issues/244</a>>`_: Fix default mathjax js path point to <code class="docutils literal notranslate"><span class="pre">http://</span></code> that cause
mixed-content error on HTTPS server. Thanks to sbrandtb and robo9k.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/157">PR#157</a>: autodoc remove spurious signatures from @property decorated
attributes. Thanks to David Ham.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/159">PR#159</a>: Add coverage targets to quickstart generated Makefile and make.bat.
Thanks to Matthias Troffaes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1251">#1251</a>: When specifying toctree :numbered: option and :tocdepth: metadata,
sub section number that is larger depth than <code class="docutils literal notranslate"><span class="pre">:tocdepth:</span></code> is shrunk.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/260">PR#260</a>: Encode underscore in citation labels for latex export. Thanks to
Lennart Fricke.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/264">PR#264</a>: Fix could not resolve xref for figure node with :name: option.
Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/265">PR#265</a>: Fix could not capture caption of graphviz node by xref. Thanks to
Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/263">PR#263</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1013">#1013</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1103">#1103</a>: Rewrite of C++ domain. Thanks to Jakob Lykke Andersen.</p>
<ul>
<li><p>Hyperlinks to all found nested names and template arguments (<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1103">#1103</a>).</p></li>
<li><p>Support for function types everywhere, e.g., in
std::function<bool(int, int)> (<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1013">#1013</a>).</p></li>
<li><p>Support for virtual functions.</p></li>
<li><p>Changed interpretation of function arguments to following standard
prototype declarations, i.e., void f(arg) means that arg is the type of the
argument, instead of it being the name.</p></li>
<li><p>Updated tests.</p></li>
<li><p>Updated documentation with elaborate description of what declarations are
supported and how the namespace declarations influence declaration and
cross-reference lookup.</p></li>
<li><p>Index names may be different now. Elements are indexed by their fully
qualified name. It should be rather easy to change this behaviour and
potentially index by namespaces/classes as well.</p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/258">PR#258</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/939">#939</a>: Add dedent option for <a class="reference internal" href="usage/restructuredtext/directives.html#directive-code-block" title="code-block directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">code-block</span></code></a> and
<a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a>. Thanks to Zafar Siddiqui.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/268">PR#268</a>: Fix numbering section does not work at singlehtml mode. It still
ad-hoc fix because there is a issue that section IDs are conflicted.
Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/273">PR#273</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1536">#1536</a>: Fix RuntimeError with numbered circular toctree. Thanks to
Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/274">PR#274</a>: Set its URL as a default title value if URL appears in toctree.
Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/276">PR#276</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1381">#1381</a>: <a class="reference internal" href="usage/restructuredtext/roles.html#role-rfc" title="rfc role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">rfc</span></code></a> and <a class="reference internal" href="usage/restructuredtext/roles.html#role-pep" title="pep role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">pep</span></code></a> roles support custom link
text. Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/277">PR#277</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1513">#1513</a>: highlights for function pointers in argument list of
<a class="reference internal" href="usage/restructuredtext/domains.html#directive-c-function" title="c:function directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">c:function</span></code></a>. Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/278">PR#278</a>: Fix section entries were shown twice if toctree has been put under
only directive. Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1547">#1547</a>: pgen2 tokenizer doesn’t recognize <code class="docutils literal notranslate"><span class="pre">...</span></code> literal (Ellipsis for py3).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/294">PR#294</a>: On LaTeX builder, wrap float environment on writing literal_block
to avoid separation of caption and body. Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/295">PR#295</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1520">#1520</a>: <code class="docutils literal notranslate"><span class="pre">make.bat</span> <span class="pre">latexpdf</span></code> mechanism to <code class="docutils literal notranslate"><span class="pre">cd</span></code> back to the current
directory. Thanks to Peter Suter.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/297">PR#297</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1571">#1571</a>: Add imgpath property to all builders. It make easier to
develop builder extensions. Thanks to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1584">#1584</a>: Point to master doc in HTML “top” link.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1585">#1585</a>: Autosummary of modules broken in Sphinx 1.2.3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1610">#1610</a>: Sphinx cause AttributeError when MeCab search option is enabled and
python-mecab is not installed.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1674">#1674</a>: Do not crash if a module’s <code class="docutils literal notranslate"><span class="pre">__all__</span></code> is not a list of strings.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1673">#1673</a>: Fix crashes with <a class="reference internal" href="usage/configuration.html#confval-nitpick_ignore"><code class="xref std std-confval docutils literal notranslate"><span class="pre">nitpick_ignore</span></code></a> and <code class="docutils literal notranslate"><span class="pre">:doc:</span></code> references.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1686">#1686</a>: ifconfig directive doesn’t care about default config values.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1642">#1642</a>: Fix only one search result appearing in Chrome.</p></li>
</ul>
</section>
<section id="id2767">
<h3>Documentation<a class="headerlink" href="#id2767" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Add clarification about the syntax of tags. (<code class="file docutils literal notranslate"><span class="pre">doc/markup/misc.rst</span></code>)</p></li>
</ul>
</section>
</section>
<section id="release-1-2-3-released-sep-1-2014">
<h2>Release 1.2.3 (released Sep 1, 2014)<a class="headerlink" href="#release-1-2-3-released-sep-1-2014" title="Link to this heading">¶</a></h2>
<section id="id2768">
<h3>Features added<a class="headerlink" href="#id2768" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1518">#1518</a>: <code class="docutils literal notranslate"><span class="pre">sphinx-apidoc</span></code> command now has a <code class="docutils literal notranslate"><span class="pre">--version</span></code> option to show
version information and exit</p></li>
<li><p>New locales: Hebrew, European Portuguese, Vietnamese.</p></li>
</ul>
</section>
<section id="id2770">
<h3>Bugs fixed<a class="headerlink" href="#id2770" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/636">#636</a>: Keep straight single quotes in literal blocks in the LaTeX build.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1419">#1419</a>: Generated i18n sphinx.js files are missing message catalog entries
from ‘.js_t’ and ‘.html’. The issue was introduced from Sphinx 1.1</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1363">#1363</a>: Fix i18n: missing python domain’s cross-references with currentmodule
directive or currentclass directive.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1444">#1444</a>: autosummary does not create the description from attributes docstring.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1457">#1457</a>: In python3 environment, make linkcheck cause “Can’t convert ‘bytes’
object to str implicitly” error when link target url has a hash part.
Thanks to Jorge_C.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1467">#1467</a>: Exception on Python3 if nonexistent method is specified by automethod</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1441">#1441</a>: autosummary can’t handle nested classes correctly.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1499">#1499</a>: With non-callable <code class="docutils literal notranslate"><span class="pre">setup</span></code> in a conf.py, now sphinx-build emits
a user-friendly error message.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1502">#1502</a>: In autodoc, fix display of parameter defaults containing backslashes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1226">#1226</a>: autodoc, autosummary: importing setup.py by automodule will invoke
setup process and execute <code class="docutils literal notranslate"><span class="pre">sys.exit()</span></code>. Now sphinx avoids SystemExit
exception and emits warnings without unexpected termination.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1503">#1503</a>: py:function directive generate incorrectly signature when specifying
a default parameter with an empty list <code class="docutils literal notranslate"><span class="pre">[]</span></code>. Thanks to Geert Jansen.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1508">#1508</a>: Non-ASCII filename raise exception on make singlehtml, latex, man,
texinfo and changes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1531">#1531</a>: On Python3 environment, docutils.conf with ‘source_link=true’ in the
general section cause type error.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/270">PR#270</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1533">#1533</a>: Non-ASCII docstring cause UnicodeDecodeError when uses with
inheritance-diagram directive. Thanks to WAKAYAMA shirou.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/281">PR#281</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/282">PR#282</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1509">#1509</a>: TODO extension not compatible with websupport. Thanks
to Takeshi Komiya.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1477">#1477</a>: gettext does not extract nodes.line in a table or list.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1544">#1544</a>: <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">text</span></code> generates wrong table when it has empty table cells.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1522">#1522</a>: Footnotes from table get displayed twice in LaTeX. This problem has
been appeared from Sphinx 1.2.1 by <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/949">#949</a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/508">#508</a>: Sphinx every time exit with zero when is invoked from setup.py command.
ex. <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">build_sphinx</span> <span class="pre">-b</span> <span class="pre">doctest</span></code> return zero even if doctest
failed.</p></li>
</ul>
</section>
</section>
<section id="release-1-2-2-released-mar-2-2014">
<h2>Release 1.2.2 (released Mar 2, 2014)<a class="headerlink" href="#release-1-2-2-released-mar-2-2014" title="Link to this heading">¶</a></h2>
<section id="id2791">
<h3>Bugs fixed<a class="headerlink" href="#id2791" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/211">PR#211</a>: When checking for existence of the <a class="reference internal" href="usage/configuration.html#confval-html_logo"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_logo</span></code></a> file, check
the full relative path and not the basename.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/212">PR#212</a>: Fix traceback with autodoc and <code class="docutils literal notranslate"><span class="pre">__init__</span></code> methods without docstring.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/213">PR#213</a>: Fix a missing import in the setup command.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1357">#1357</a>: Option names documented by <a class="reference internal" href="usage/restructuredtext/domains.html#directive-option" title="option directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">option</span></code></a> are now again allowed to
not start with a dash or slash, and referencing them will work correctly.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1358">#1358</a>: Fix handling of image paths outside of the source directory when using
the “wildcard” style reference.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1374">#1374</a>: Fix for autosummary generating overly-long summaries if first line
doesn’t end with a period.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1383">#1383</a>: Fix Python 2.5 compatibility of sphinx-apidoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1391">#1391</a>: Actually prevent using “pngmath” and “mathjax” extensions at the same
time in sphinx-quickstart.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1386">#1386</a>: Fix bug preventing more than one theme being added by the entry point
mechanism.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1370">#1370</a>: Ignore “toctree” nodes in text writer, instead of raising.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1364">#1364</a>: Fix ‘make gettext’ fails when the ‘.. todolist::’ directive is present.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1367">#1367</a>: Fix a change of <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/96">PR#96</a> that break sphinx.util.docfields.Field.make_field
interface/behavior for <code class="docutils literal notranslate"><span class="pre">item</span></code> argument usage.</p></li>
</ul>
</section>
<section id="id2801">
<h3>Documentation<a class="headerlink" href="#id2801" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Extended the <a class="reference internal" href="extdev/index.html#dev-extensions"><span class="std std-ref">documentation about building extensions</span></a>.</p></li>
</ul>
</section>
</section>
<section id="release-1-2-1-released-jan-19-2014">
<h2>Release 1.2.1 (released Jan 19, 2014)<a class="headerlink" href="#release-1-2-1-released-jan-19-2014" title="Link to this heading">¶</a></h2>
<section id="id2802">
<h3>Bugs fixed<a class="headerlink" href="#id2802" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1335">#1335</a>: Fix autosummary template overloading with exclamation prefix like
<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">extends</span> <span class="pre">"!autosummary/class.rst"</span> <span class="pre">%}</span></code> cause infinite recursive function
call. This was caused by <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/181">PR#181</a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1337">#1337</a>: Fix autodoc with <code class="docutils literal notranslate"><span class="pre">autoclass_content="both"</span></code> uses useless
<code class="docutils literal notranslate"><span class="pre">object.__init__</span></code> docstring when class does not have <code class="docutils literal notranslate"><span class="pre">__init__</span></code>.
This was caused by a change for <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1138">#1138</a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1340">#1340</a>: Can’t search alphabetical words on the HTML quick search generated
with language=’ja’.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1319">#1319</a>: Do not crash if the <a class="reference internal" href="usage/configuration.html#confval-html_logo"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_logo</span></code></a> file does not exist.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/603">#603</a>: Do not use the HTML-ized title for building the search index (that
resulted in “literal” being found on every page with a literal in the
title).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/751">#751</a>: Allow production lists longer than a page in LaTeX by using longtable.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/764">#764</a>: Always look for stopwords lowercased in JS search.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/814">#814</a>: autodoc: Guard against strange type objects that don’t have
<code class="docutils literal notranslate"><span class="pre">__bases__</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/932">#932</a>: autodoc: Do not crash if <code class="docutils literal notranslate"><span class="pre">__doc__</span></code> is not a string.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/933">#933</a>: Do not crash if an <a class="reference internal" href="usage/restructuredtext/roles.html#role-option" title="option role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">option</span></code></a> value is malformed (contains
spaces but no option name).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/908">#908</a>: On Python 3, handle error messages from LaTeX correctly in the pngmath
extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/943">#943</a>: In autosummary, recognize “first sentences” to pull from the docstring
if they contain uppercase letters.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/923">#923</a>: Take the entire LaTeX document into account when caching
pngmath-generated images. This rebuilds them correctly when
<code class="docutils literal notranslate"><span class="pre">pngmath_latex_preamble</span></code> changes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/901">#901</a>: Emit a warning when using docutils’ new “math” markup without a Sphinx
math extension active.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/845">#845</a>: In code blocks, when the selected lexer fails, display line numbers
nevertheless if configured.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/929">#929</a>: Support parsed-literal blocks in LaTeX output correctly.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/949">#949</a>: Update the tabulary.sty packed with Sphinx.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1050">#1050</a>: Add anonymous labels into <code class="docutils literal notranslate"><span class="pre">objects.inv</span></code> to be referenced via
<a class="reference internal" href="usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx" title="sphinx.ext.intersphinx: Link to other Sphinx documentation."><code class="xref py py-mod docutils literal notranslate"><span class="pre">intersphinx</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1095">#1095</a>: Fix print-media stylesheet being included always in the “scrolls”
theme.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1085">#1085</a>: Fix current classname not getting set if class description has
<code class="docutils literal notranslate"><span class="pre">:noindex:</span></code> set.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1181">#1181</a>: Report option errors in autodoc directives more gracefully.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1155">#1155</a>: Fix autodocumenting C-defined methods as attributes in Python 3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1233">#1233</a>: Allow finding both Python classes and exceptions with the “class” and
“exc” roles in intersphinx.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1198">#1198</a>: Allow “image” for the “figwidth” option of the <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#figure">figure</a>
directive as documented by docutils.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1152">#1152</a>: Fix pycode parsing errors of Python 3 code by including two grammar
versions for Python 2 and 3, and loading the appropriate version for the
running Python version.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1017">#1017</a>: Be helpful and tell the user when the argument to <a class="reference internal" href="usage/restructuredtext/domains.html#directive-option" title="option directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">option</span></code></a>
does not match the required format.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1345">#1345</a>: Fix two bugs with <a class="reference internal" href="usage/configuration.html#confval-nitpick_ignore"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">nitpick_ignore</span></code></a>; now you don’t have to
remove the store environment for changes to have effect.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1072">#1072</a>: In the JS search, fix issues searching for upper-cased words by
lowercasing words before stemming.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1299">#1299</a>: Make behavior of the <a class="reference internal" href="usage/restructuredtext/directives.html#directive-math" title="math directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">math</span></code></a> directive more consistent and
avoid producing empty environments in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1308">#1308</a>: Strip HTML tags from the content of “raw” nodes before feeding it
to the search indexer.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1249">#1249</a>: Fix duplicate LaTeX page numbering for manual documents.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1292">#1292</a>: In the linkchecker, retry HEAD requests when denied by HTTP 405.
Also make the redirect code apparent and tweak the output a bit to be
more obvious.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1285">#1285</a>: Avoid name clashes between C domain objects and section titles.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/848">#848</a>: Always take the newest code in incremental rebuilds with the
<a class="reference internal" href="usage/extensions/viewcode.html#module-sphinx.ext.viewcode" title="sphinx.ext.viewcode: Add links to a highlighted version of the source code."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.viewcode</span></code></a> extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/979">#979</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1266">#1266</a>: Fix exclude handling in <code class="docutils literal notranslate"><span class="pre">sphinx-apidoc</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1302">#1302</a>: Fix regression in <a class="reference internal" href="usage/extensions/inheritance.html#module-sphinx.ext.inheritance_diagram" title="sphinx.ext.inheritance_diagram: Support for displaying inheritance diagrams via graphviz."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.inheritance_diagram</span></code></a> when
documenting classes that can’t be pickled.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1316">#1316</a>: Remove hard-coded <code class="docutils literal notranslate"><span class="pre">font-face</span></code> resources from epub theme.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1329">#1329</a>: Fix traceback with empty translation msgstr in .po files.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1300">#1300</a>: Fix references not working in translated documents in some instances.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1283">#1283</a>: Fix a bug in the detection of changed files that would try to access
doctrees of deleted documents.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1330">#1330</a>: Fix <a class="reference internal" href="usage/configuration.html#confval-exclude_patterns"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">exclude_patterns</span></code></a> behavior with subdirectories in the
<a class="reference internal" href="usage/configuration.html#confval-html_static_path"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_static_path</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1323">#1323</a>: Fix emitting empty <code class="docutils literal notranslate"><span class="pre"><ul></span></code> tags in the HTML writer, which is not
valid HTML.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1147">#1147</a>: Don’t emit a sidebar search box in the “singlehtml” builder.</p></li>
</ul>
</section>
<section id="id2848">
<h3>Documentation<a class="headerlink" href="#id2848" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1325">#1325</a>: Added a “Intersphinx” tutorial section. (<code class="file docutils literal notranslate"><span class="pre">doc/tutorial.rst</span></code>)</p></li>
</ul>
</section>
</section>
<section id="release-1-2-released-dec-10-2013">
<h2>Release 1.2 (released Dec 10, 2013)<a class="headerlink" href="#release-1-2-released-dec-10-2013" title="Link to this heading">¶</a></h2>
<section id="id2850">
<h3>Features added<a class="headerlink" href="#id2850" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Added <code class="docutils literal notranslate"><span class="pre">sphinx.version_info</span></code> tuple for programmatic checking of the Sphinx
version.</p></li>
</ul>
</section>
<section id="id2851">
<h3>Incompatible changes<a class="headerlink" href="#id2851" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Removed the <code class="docutils literal notranslate"><span class="pre">sphinx.ext.refcounting</span></code> extension – it is very specific to
CPython and has no place in the main distribution.</p></li>
</ul>
</section>
<section id="id2852">
<h3>Bugs fixed<a class="headerlink" href="#id2852" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Restore <code class="docutils literal notranslate"><span class="pre">versionmodified</span></code> CSS class for versionadded/changed and deprecated
directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/181">PR#181</a>: Fix <code class="docutils literal notranslate"><span class="pre">html_theme_path</span> <span class="pre">=</span> <span class="pre">['.']</span></code> is a trigger of rebuild all documents
always (This change keeps the current “theme changes cause a rebuild”
feature).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1296">#1296</a>: Fix invalid charset in HTML help generated HTML files for default
locale.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/190">PR#190</a>: Fix gettext does not extract figure caption and rubric title inside
other blocks. Thanks to Michael Schlenker.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/176">PR#176</a>: Make sure setup_command test can always import Sphinx. Thanks to
Dmitry Shachnev.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1311">#1311</a>: Fix test_linkcode.test_html fails with C locale and Python 3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1269">#1269</a>: Fix ResourceWarnings with Python 3.2 or later.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1138">#1138</a>: Fix: When <code class="docutils literal notranslate"><span class="pre">autodoc_docstring_signature</span> <span class="pre">=</span> <span class="pre">True</span></code> and
<code class="docutils literal notranslate"><span class="pre">autoclass_content</span> <span class="pre">=</span> <span class="pre">'init'</span></code> or <code class="docutils literal notranslate"><span class="pre">'both'</span></code>, __init__ line should be
removed from class documentation.</p></li>
</ul>
</section>
</section>
<section id="release-1-2-beta3-released-oct-3-2013">
<h2>Release 1.2 beta3 (released Oct 3, 2013)<a class="headerlink" href="#release-1-2-beta3-released-oct-3-2013" title="Link to this heading">¶</a></h2>
<section id="id2858">
<h3>Features added<a class="headerlink" href="#id2858" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>The Sphinx error log files will now include a list of the loaded extensions
for help in debugging.</p></li>
</ul>
</section>
<section id="id2859">
<h3>Incompatible changes<a class="headerlink" href="#id2859" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/154">PR#154</a>: Remove “sphinx” prefix from LaTeX class name except ‘sphinxmanual’
and ‘sphinxhowto’. Now you can use your custom document class without
‘sphinx’ prefix. Thanks to Erik B.</p></li>
</ul>
</section>
<section id="id2860">
<h3>Bugs fixed<a class="headerlink" href="#id2860" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1265">#1265</a>: Fix i18n: crash when translating a section name that is pointed to from
a named target.</p></li>
<li><p>A wrong condition broke the search feature on first page that is usually
index.rst. This issue was introduced in 1.2b1.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/703">#703</a>: When Sphinx can’t decode filenames with non-ASCII characters, Sphinx now
catches UnicodeError and will continue if possible instead of raising the
exception.</p></li>
</ul>
</section>
</section>
<section id="release-1-2-beta2-released-sep-17-2013">
<h2>Release 1.2 beta2 (released Sep 17, 2013)<a class="headerlink" href="#release-1-2-beta2-released-sep-17-2013" title="Link to this heading">¶</a></h2>
<section id="id2863">
<h3>Features added<a class="headerlink" href="#id2863" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">apidoc</span></code> now ignores “_private” modules by default, and has an option <code class="docutils literal notranslate"><span class="pre">-P</span></code>
to include them.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">apidoc</span></code> now has an option to not generate headings for packages and
modules, for the case that the module docstring already includes a reST
heading.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/161">PR#161</a>: <code class="docutils literal notranslate"><span class="pre">apidoc</span></code> can now write each module to a standalone page instead of
combining all modules in a package on one page.</p></li>
<li><p>Builders: rebuild i18n target document when catalog updated.</p></li>
<li><p>Support docutils.conf ‘writers’ and ‘html4css1 writer’ section in the HTML
writer. The latex, manpage and texinfo writers also support their respective
‘writers’ sections.</p></li>
<li><p>The new <a class="reference internal" href="usage/configuration.html#confval-html_extra_path"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_extra_path</span></code></a> config value allows to specify directories
with files that should be copied directly to the HTML output directory.</p></li>
<li><p>Autodoc directives for module data and attributes now support an
<code class="docutils literal notranslate"><span class="pre">annotation</span></code> option, so that the default display of the data/attribute
value can be overridden.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/136">PR#136</a>: Autodoc directives now support an <code class="docutils literal notranslate"><span class="pre">imported-members</span></code> option to
include members imported from different modules.</p></li>
<li><p>New locales: Macedonian, Sinhala, Indonesian.</p></li>
<li><p>Theme package collection by using setuptools plugin mechanism.</p></li>
</ul>
</section>
<section id="id2864">
<h3>Incompatible changes<a class="headerlink" href="#id2864" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/144">PR#144</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1182">#1182</a>: Force timezone offset to LocalTimeZone on POT-Creation-Date
that was generated by gettext builder. Thanks to masklinn and Jakub Wilk.</p></li>
</ul>
</section>
<section id="id2866">
<h3>Bugs fixed<a class="headerlink" href="#id2866" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/132">PR#132</a>: Updated jQuery version to 1.8.3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/141">PR#141</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/982">#982</a>: Avoid crash when writing PNG file using Python 3. Thanks to
Marcin Wojdyr.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/145">PR#145</a>: In parallel builds, sphinx drops second document file to write.
Thanks to tychoish.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/151">PR#151</a>: Some styling updates to tables in LaTeX.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/153">PR#153</a>: The “extensions” config value can now be overridden.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/155">PR#155</a>: Added support for some C++11 function qualifiers.</p></li>
<li><p>Fix: ‘make gettext’ caused UnicodeDecodeError when templates contain utf-8
encoded strings.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/828">#828</a>: use inspect.getfullargspec() to be able to document functions with
keyword-only arguments on Python 3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1090">#1090</a>: Fix i18n: multiple cross references (term, ref, doc) in the same line
return the same link.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1157">#1157</a>: Combination of ‘globaltoc.html’ and hidden toctree caused exception.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1159">#1159</a>: fix wrong generation of objects inventory for Python modules, and
add a workaround in intersphinx to fix handling of affected inventories.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1160">#1160</a>: Citation target missing caused an AssertionError.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1162">#1162</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/139">PR#139</a>: singlehtml builder didn’t copy images to _images/.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1173">#1173</a>: Adjust setup.py dependencies because Jinja2 2.7 discontinued
compatibility with Python < 3.3 and Python < 2.6. Thanks to Alexander Dupuy.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1185">#1185</a>: Don’t crash when a Python module has a wrong or no encoding declared,
and non-ASCII characters are included.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1188">#1188</a>: sphinx-quickstart raises UnicodeEncodeError if “Project version”
includes non-ASCII characters.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1189">#1189</a>: “Title underline is too short” WARNING is given when using fullwidth
characters to “Project name” on quickstart.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1190">#1190</a>: Output TeX/texinfo/man filename has no basename (only extension)
when using non-ASCII characters in the “Project name” on quickstart.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1192">#1192</a>: Fix escaping problem for hyperlinks in the manpage writer.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1193">#1193</a>: Fix i18n: multiple link references in the same line return the same
link.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1176">#1176</a>: Fix i18n: footnote reference number missing for auto numbered named
footnote and auto symbol footnote.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/146">PR#146</a>,`#1172 <<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1172">https://github.com/sphinx-doc/sphinx/issues/1172</a>>`_: Fix ZeroDivisionError in parallel builds. Thanks to tychoish.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1204">#1204</a>: Fix wrong generation of links to local intersphinx targets.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1206">#1206</a>: Fix i18n: gettext did not translate admonition directive’s title.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1232">#1232</a>: Sphinx generated broken ePub files on Windows.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1259">#1259</a>: Guard the debug output call when emitting events; to prevent the
repr() implementation of arbitrary objects causing build failures.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1142">#1142</a>: Fix NFC/NFD normalizing problem of rst filename on Mac OS X.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1234">#1234</a>: Ignoring the string consists only of white-space characters.</p></li>
</ul>
</section>
</section>
<section id="release-1-2-beta1-released-mar-31-2013">
<h2>Release 1.2 beta1 (released Mar 31, 2013)<a class="headerlink" href="#release-1-2-beta1-released-mar-31-2013" title="Link to this heading">¶</a></h2>
<section id="id2888">
<h3>Incompatible changes<a class="headerlink" href="#id2888" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Removed <code class="docutils literal notranslate"><span class="pre">sphinx.util.compat.directive_dwim()</span></code> and
<code class="docutils literal notranslate"><span class="pre">sphinx.roles.xfileref_role()</span></code> which were deprecated since version 1.0.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/122">PR#122</a>: the files given in <a class="reference internal" href="usage/configuration.html#confval-latex_additional_files"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_additional_files</span></code></a> now override TeX
files included by Sphinx, such as <code class="docutils literal notranslate"><span class="pre">sphinx.sty</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/124">PR#124</a>: the node generated by <a class="reference internal" href="usage/restructuredtext/directives.html#directive-versionadded" title="versionadded directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">versionadded</span></code></a>,
<a class="reference internal" href="usage/restructuredtext/directives.html#directive-versionchanged" title="versionchanged directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">versionchanged</span></code></a> and <a class="reference internal" href="usage/restructuredtext/directives.html#directive-deprecated" title="deprecated directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">deprecated</span></code></a> directives now includes
all added markup (such as “New in version X”) as child nodes, and no
additional text must be generated by writers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/99">PR#99</a>: the <a class="reference internal" href="usage/restructuredtext/directives.html#directive-seealso" title="seealso directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">seealso</span></code></a> directive now generates admonition nodes instead
of the custom <code class="docutils literal notranslate"><span class="pre">seealso</span></code> node.</p></li>
</ul>
</section>
<section id="id2889">
<h3>Features added<a class="headerlink" href="#id2889" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Markup</p>
<ul>
<li><p>The <a class="reference internal" href="usage/restructuredtext/directives.html#directive-toctree" title="toctree directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">toctree</span></code></a> directive and the <code class="docutils literal notranslate"><span class="pre">toctree()</span></code> template function now
have an <code class="docutils literal notranslate"><span class="pre">includehidden</span></code> option that includes hidden toctree entries (bugs
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/790">#790</a> and <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1047">#1047</a>). A bug in the <code class="docutils literal notranslate"><span class="pre">maxdepth</span></code> option for the <code class="docutils literal notranslate"><span class="pre">toctree()</span></code>
template function has been fixed (bug <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1046">#1046</a>).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/99">PR#99</a>: Strip down seealso directives to normal admonitions. This removes
their unusual CSS classes (admonition-see-also), inconsistent LaTeX
admonition title (“See Also” instead of “See also”), and spurious
indentation in the text builder.</p></li>
</ul>
</li>
<li><p>HTML builder</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/783">#783</a>: Create a link to full size image if it is scaled with width or height.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1067">#1067</a>: Improve the ordering of the JavaScript search results: matches in
titles come before matches in full text, and object results are better
categorized. Also implement a pluggable search scorer.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1053">#1053</a>: The “rightsidebar” and “collapsiblesidebar” HTML theme options now
work together.</p></li>
<li><p>Update to jQuery 1.7.1 and Underscore.js 1.3.1.</p></li>
</ul>
</li>
<li><p>Texinfo builder</p>
<ul>
<li><p>An “Index” node is no longer added when there are no entries.</p></li>
<li><p>“deffn” categories are no longer capitalized if they contain capital
letters.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">desc_annotation</span></code> nodes are now rendered.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">strong</span></code> and <code class="docutils literal notranslate"><span class="pre">emphasis</span></code> nodes are now formatted like
<code class="docutils literal notranslate"><span class="pre">literal</span></code>s. The reason for this is because the standard Texinfo markup
(<code class="docutils literal notranslate"><span class="pre">*strong*</span></code> and <code class="docutils literal notranslate"><span class="pre">_emphasis_</span></code>) resulted in confusing output due to the
common usage of using these constructs for documenting parameter names.</p></li>
<li><p>Field lists formatting has been tweaked to better display
“Info field lists”.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">system_message</span></code> and <code class="docutils literal notranslate"><span class="pre">problematic</span></code> nodes are now formatted in a similar
fashion as done by the text builder.</p></li>
<li><p>“en-dash” and “em-dash” conversion of hyphens is no longer performed in
option directive signatures.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">@ref</span></code> is now used instead of <code class="docutils literal notranslate"><span class="pre">@pxref</span></code> for cross-references which
prevents the word “see” from being added before the link (does not affect
the Info output).</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">@finalout</span></code> command has been added for better TeX output.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">transition</span></code> nodes are now formatted using underscores (“_”) instead of
asterisks (“*”).</p></li>
<li><p>The default value for the <code class="docutils literal notranslate"><span class="pre">paragraphindent</span></code> has been changed from 2 to 0
meaning that paragraphs are no longer indented by default.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1110">#1110</a>: A new configuration value <a class="reference internal" href="usage/configuration.html#confval-texinfo_no_detailmenu"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">texinfo_no_detailmenu</span></code></a> has been
added for controlling whether a <code class="docutils literal notranslate"><span class="pre">@detailmenu</span></code> is added in the “Top”
node’s menu.</p></li>
<li><p>Detailed menus are no longer created except for the “Top” node.</p></li>
<li><p>Fixed an issue where duplicate domain indices would result in invalid
output.</p></li>
</ul>
</li>
<li><p>LaTeX builder:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/115">PR#115</a>: Add <code class="docutils literal notranslate"><span class="pre">'transition'</span></code> item in <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a> for
customizing how transitions are displayed. Thanks to Jeff Klukas.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/114">PR#114</a>: The LaTeX writer now includes the “cmap” package by default. The
<code class="docutils literal notranslate"><span class="pre">'cmappkg'</span></code> item in <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a> can be used to control this.
Thanks to Dmitry Shachnev.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">'fontpkg'</span></code> item in <a class="reference internal" href="usage/configuration.html#confval-latex_elements"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_elements</span></code></a> now defaults to <code class="docutils literal notranslate"><span class="pre">''</span></code>
when the <a class="reference internal" href="usage/configuration.html#confval-language"><code class="xref std std-confval docutils literal notranslate"><span class="pre">language</span></code></a> uses the Cyrillic script. Suggested by Dmitry
Shachnev.</p></li>
<li><p>The <a class="reference internal" href="usage/configuration.html#confval-latex_documents"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_documents</span></code></a>, <a class="reference internal" href="usage/configuration.html#confval-texinfo_documents"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">texinfo_documents</span></code></a>, and
<a class="reference internal" href="usage/configuration.html#confval-man_pages"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">man_pages</span></code></a> configuration values will be set to default values based
on the <a class="reference internal" href="usage/configuration.html#confval-master_doc"><code class="xref std std-confval docutils literal notranslate"><span class="pre">master_doc</span></code></a> if not explicitly set in <code class="file docutils literal notranslate"><span class="pre">conf.py</span></code>.
Previously, if these values were not set, no output would be generated by
their respective builders.</p></li>
</ul>
</li>
<li><p>Internationalization:</p>
<ul>
<li><p>Add i18n capabilities for custom templates. For example: The Sphinx
reference documentation in doc directory provides a <code class="docutils literal notranslate"><span class="pre">sphinx.pot</span></code> file with
message strings from <code class="docutils literal notranslate"><span class="pre">doc/_templates/*.html</span></code> when using <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">gettext</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/61">PR#61</a>,`#703 <<a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/703">https://github.com/sphinx-doc/sphinx/issues/703</a>>`_: Add support for non-ASCII filename handling.</p></li>
</ul>
</li>
<li><p>Other builders:</p>
<ul>
<li><p>Added the Docutils-native XML and pseudo-XML builders. See
<a class="reference internal" href="usage/builders/index.html#sphinx.builders.xml.XMLBuilder" title="sphinx.builders.xml.XMLBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">XMLBuilder</span></code></a> and
<a class="reference internal" href="usage/builders/index.html#sphinx.builders.xml.PseudoXMLBuilder" title="sphinx.builders.xml.PseudoXMLBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">PseudoXMLBuilder</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/45">PR#45</a>: The linkcheck builder now checks <code class="docutils literal notranslate"><span class="pre">#anchor</span></code>s for existence.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/123">PR#123</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1106">#1106</a>: Add <a class="reference internal" href="usage/configuration.html#confval-epub_use_index"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">epub_use_index</span></code></a> configuration value. If
provided, it will be used instead of <a class="reference internal" href="usage/configuration.html#confval-html_use_index"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_use_index</span></code></a> for epub
builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/126">PR#126</a>: Add <a class="reference internal" href="usage/configuration.html#confval-epub_tocscope"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">epub_tocscope</span></code></a> configuration value. The setting
controls the generation of the epub toc. The user can now also include
hidden toc entries.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/112">PR#112</a>: Add <a class="reference internal" href="usage/configuration.html#confval-epub_show_urls"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">epub_show_urls</span></code></a> configuration value.</p></li>
</ul>
</li>
<li><p>Extensions:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/52">PR#52</a>: <code class="docutils literal notranslate"><span class="pre">special_members</span></code> flag to autodoc now behaves like <code class="docutils literal notranslate"><span class="pre">members</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/47">PR#47</a>: Added <a class="reference internal" href="usage/extensions/linkcode.html#module-sphinx.ext.linkcode" title="sphinx.ext.linkcode: Add external links to source code."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.linkcode</span></code></a> extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/25">PR#25</a>: In inheritance diagrams, the first line of the class docstring
is now the tooltip for the class.</p></li>
</ul>
</li>
<li><p>Command-line interfaces:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/75">PR#75</a>: Added <code class="docutils literal notranslate"><span class="pre">--follow-links</span></code> option to sphinx-apidoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/869">#869</a>: sphinx-build now has the option <code class="docutils literal notranslate"><span class="pre">-T</span></code> for printing the full
traceback after an unhandled exception.</p></li>
<li><p>sphinx-build now supports the standard <code class="docutils literal notranslate"><span class="pre">--help</span></code> and <code class="docutils literal notranslate"><span class="pre">--version</span></code> options.</p></li>
<li><p>sphinx-build now provides more specific error messages when called with
invalid options or arguments.</p></li>
<li><p>sphinx-build now has a verbose option <code class="docutils literal notranslate"><span class="pre">-v</span></code> which can be repeated for
greater effect. A single occurrence provides a slightly more verbose output
than normal. Two or more occurrences of this option provides more detailed
output which may be useful for debugging.</p></li>
</ul>
</li>
<li><p>Locales:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/74">PR#74</a>: Fix some Russian translation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/54">PR#54</a>: Added Norwegian bokmaal translation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/35">PR#35</a>: Added Slovak translation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/28">PR#28</a>: Added Hungarian translation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1113">#1113</a>: Add Hebrew locale.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1097">#1097</a>: Add Basque locale.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1037">#1037</a>: Fix typos in Polish translation. Thanks to Jakub Wilk.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1012">#1012</a>: Update Estonian translation.</p></li>
</ul>
</li>
<li><p>Optimizations:</p>
<ul>
<li><p>Speed up building the search index by caching the results of the word
stemming routines. Saves about 20 seconds when building the Python
documentation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/108">PR#108</a>: Add experimental support for parallel building with a new
<a class="reference internal" href="man/sphinx-build.html#cmdoption-sphinx-build-j"><code class="xref std std-option docutils literal notranslate"><span class="pre">sphinx-build</span> <span class="pre">-j</span></code></a> option.</p></li>
</ul>
</li>
</ul>
</section>
<section id="id2904">
<h3>Documentation<a class="headerlink" href="#id2904" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/88">PR#88</a>: Added the “Sphinx Developer’s Guide” (<code class="file docutils literal notranslate"><span class="pre">doc/devguide.rst</span></code>)
which outlines the basic development process of the Sphinx project.</p></li>
<li><p>Added a detailed “Installing Sphinx” document (<code class="file docutils literal notranslate"><span class="pre">doc/install.rst</span></code>).</p></li>
</ul>
</section>
<section id="id2905">
<h3>Bugs fixed<a class="headerlink" href="#id2905" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/124">PR#124</a>: Fix paragraphs in versionmodified are ignored when it has no
dangling paragraphs. Fix wrong html output (nested <code class="docutils literal notranslate"><span class="pre"><p></span></code> tag). Fix
versionmodified is not translatable. Thanks to Nozomu Kaneko.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/111">PR#111</a>: Respect add_autodoc_attrgetter() even when inherited-members is set.
Thanks to A. Jesse Jiryu Davis.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/97">PR#97</a>: Fix footnote handling in translated documents.</p></li>
<li><p>Fix text writer not handling visit_legend for figure directive contents.</p></li>
<li><p>Fix text builder not respecting wide/fullwidth characters: title underline
width, table layout width and text wrap width.</p></li>
<li><p>Fix leading space in LaTeX table header cells.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1132">#1132</a>: Fix LaTeX table output for multi-row cells in the first column.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1128">#1128</a>: Fix Unicode errors when trying to format time strings with a
non-standard locale.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1127">#1127</a>: Fix traceback when autodoc tries to tokenize a non-Python file.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1126">#1126</a>: Fix double-hyphen to en-dash conversion in wrong places such as
command-line option names in LaTeX.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1123">#1123</a>: Allow whitespaces in filenames given to <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1120">#1120</a>: Added improvements about i18n for themes “basic”, “haiku” and
“scrolls” that Sphinx built-in. Thanks to Leonardo J. Caballero G.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1118">#1118</a>: Updated Spanish translation. Thanks to Leonardo J. Caballero G.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1117">#1117</a>: Handle .pyx files in sphinx-apidoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1112">#1112</a>: Avoid duplicate download files when referenced from documents in
different ways (absolute/relative).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1111">#1111</a>: Fix failure to find uppercase words in search when
<a class="reference internal" href="usage/configuration.html#confval-html_search_language"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_search_language</span></code></a> is ‘ja’. Thanks to Tomo Saito.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1108">#1108</a>: The text writer now correctly numbers enumerated lists with
non-default start values (based on patch by Ewan Edwards).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1102">#1102</a>: Support multi-context “with” statements in autodoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1090">#1090</a>: Fix gettext not extracting glossary terms.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1074">#1074</a>: Add environment version info to the generated search index to avoid
compatibility issues with old builds.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1070">#1070</a>: Avoid un-pickling issues when running Python 3 and the saved
environment was created under Python 2.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1069">#1069</a>: Fixed error caused when autodoc would try to format signatures of
“partial” functions without keyword arguments (patch by Artur Gaspar).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1062">#1062</a>: sphinx.ext.autodoc use __init__ method signature for class signature.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1055">#1055</a>: Fix web support with relative path to source directory.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1043">#1043</a>: Fix sphinx-quickstart asking again for yes/no questions because
<code class="docutils literal notranslate"><span class="pre">input()</span></code> returns values with an extra ‘r’ on Python 3.2.0 +
Windows. Thanks to Régis Décamps.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1041">#1041</a>: Fix failure of the cpp domain parser to parse a const type with a
modifier.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1038">#1038</a>: Fix failure of the cpp domain parser to parse C+11 “static constexpr”
declarations. Thanks to Jakub Wilk.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1029">#1029</a>: Fix intersphinx_mapping values not being stable if the mapping has
plural key/value set with Python 3.3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1028">#1028</a>: Fix line block output in the text builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1024">#1024</a>: Improve Makefile/make.bat error message if Sphinx is not found. Thanks
to Anatoly Techtonik.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1018">#1018</a>: Fix “container” directive handling in the text builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1015">#1015</a>: Stop overriding jQuery contains() in the JavaScript.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1010">#1010</a>: Make pngmath images transparent by default; IE7+ should handle it.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/1008">#1008</a>: Fix test failures with Python 3.3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/995">#995</a>: Fix table-of-contents and page numbering for the LaTeX “howto” class.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/976">#976</a>: Fix gettext does not extract index entries.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/72">PR#72</a>: <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/975">#975</a>: Fix gettext not extracting definition terms before docutils 0.10.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/961">#961</a>: Fix LaTeX output for triple quotes in code snippets.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/958">#958</a>: Do not preserve <code class="docutils literal notranslate"><span class="pre">environment.pickle</span></code> after a failed build.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/955">#955</a>: Fix i18n transformation.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/940">#940</a>: Fix gettext does not extract figure caption.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/920">#920</a>: Fix PIL packaging issue that allowed to import <code class="docutils literal notranslate"><span class="pre">Image</span></code> without PIL
namespace. Thanks to Marc Schlaich.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/723">#723</a>: Fix the search function on local files in WebKit based browsers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/440">#440</a>: Fix coarse timestamp resolution in some filesystem generating a wrong
list of outdated files.</p></li>
</ul>
</section>
</section>
<section id="release-1-1-3-mar-10-2012">
<h2>Release 1.1.3 (Mar 10, 2012)<a class="headerlink" href="#release-1-1-3-mar-10-2012" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/40">PR#40</a>: Fix <code class="docutils literal notranslate"><span class="pre">safe_repr</span></code> function to decode bytestrings with non-ASCII
characters correctly.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/37">PR#37</a>: Allow configuring sphinx-apidoc via <code class="docutils literal notranslate"><span class="pre">SPHINX_APIDOC_OPTIONS</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/34">PR#34</a>: Restore Python 2.4 compatibility.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/36">PR#36</a>: Make the “bibliography to TOC” fix in LaTeX output specific to
the document class.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/695">#695</a>: When the highlight language “python” is specified explicitly,
do not try to parse the code to recognize non-Python snippets.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/859">#859</a>: Fix exception under certain circumstances when not finding
appropriate objects to link to.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/860">#860</a>: Do not crash when encountering invalid doctest examples, just
emit a warning.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/864">#864</a>: Fix crash with some settings of <a class="reference internal" href="usage/configuration.html#confval-modindex_common_prefix"><code class="xref std std-confval docutils literal notranslate"><span class="pre">modindex_common_prefix</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/862">#862</a>: Fix handling of <code class="docutils literal notranslate"><span class="pre">-D</span></code> and <code class="docutils literal notranslate"><span class="pre">-A</span></code> options on Python 3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/851">#851</a>: Recognize and warn about circular toctrees, instead of running
into recursion errors.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/853">#853</a>: Restore compatibility with docutils trunk.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/852">#852</a>: Fix HtmlHelp index entry links again.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/854">#854</a>: Fix inheritance_diagram raising attribute errors on builtins.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/832">#832</a>: Fix crashes when putting comments or lone terms in a glossary.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/834">#834</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/818">#818</a>: Fix HTML help language/encoding mapping for all Sphinx
supported languages.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/844">#844</a>: Fix crashes when dealing with Unicode output in doctest extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/831">#831</a>: Provide <code class="docutils literal notranslate"><span class="pre">--project</span></code> flag in setup_command as advertised.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/875">#875</a>: Fix reading config files under Python 3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/876">#876</a>: Fix quickstart test under Python 3.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/870">#870</a>: Fix spurious KeyErrors when removing documents.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/892">#892</a>: Fix single-HTML builder misbehaving with the master document in a
subdirectory.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/873">#873</a>: Fix assertion errors with empty <code class="docutils literal notranslate"><span class="pre">only</span></code> directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/816">#816</a>: Fix encoding issues in the Qt help builder.</p></li>
</ul>
</section>
<section id="release-1-1-2-nov-1-2011-1-1-1-is-a-silly-version-number-anyway">
<h2>Release 1.1.2 (Nov 1, 2011) – 1.1.1 is a silly version number anyway!<a class="headerlink" href="#release-1-1-2-nov-1-2011-1-1-1-is-a-silly-version-number-anyway" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/809">#809</a>: Include custom fixers in the source distribution.</p></li>
</ul>
</section>
<section id="release-1-1-1-nov-1-2011">
<h2>Release 1.1.1 (Nov 1, 2011)<a class="headerlink" href="#release-1-1-1-nov-1-2011" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/791">#791</a>: Fix QtHelp, DevHelp and HtmlHelp index entry links.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/792">#792</a>: Include “sphinx-apidoc” in the source distribution.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/797">#797</a>: Don’t crash on a misformatted glossary.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/801">#801</a>: Make intersphinx work properly without SSL support.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/805">#805</a>: Make the <code class="docutils literal notranslate"><span class="pre">Sphinx.add_index_to_domain</span></code> method work correctly.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/780">#780</a>: Fix Python 2.5 compatibility.</p></li>
</ul>
</section>
<section id="release-1-1-oct-9-2011">
<h2>Release 1.1 (Oct 9, 2011)<a class="headerlink" href="#release-1-1-oct-9-2011" title="Link to this heading">¶</a></h2>
<section id="id2972">
<h3>Incompatible changes<a class="headerlink" href="#id2972" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>The <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-module" title="py:module directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">py:module</span></code></a> directive doesn’t output its <code class="docutils literal notranslate"><span class="pre">platform</span></code> option
value anymore. (It was the only thing that the directive did output, and
therefore quite inconsistent.)</p></li>
<li><p>Removed support for old dependency versions; requirements are now:</p>
<ul>
<li><p>Pygments >= 1.2</p></li>
<li><p>Docutils >= 0.7</p></li>
<li><p>Jinja2 >= 2.3</p></li>
</ul>
</li>
</ul>
</section>
<section id="id2973">
<h3>Features added<a class="headerlink" href="#id2973" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Added Python 3.x support.</p></li>
<li><p>New builders and subsystems:</p>
<ul>
<li><p>Added a Texinfo builder.</p></li>
<li><p>Added i18n support for content, a <code class="docutils literal notranslate"><span class="pre">gettext</span></code> builder and related
utilities.</p></li>
<li><p>Added the <code class="docutils literal notranslate"><span class="pre">websupport</span></code> library and builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/98">#98</a>: Added a <code class="docutils literal notranslate"><span class="pre">sphinx-apidoc</span></code> script that autogenerates a hierarchy
of source files containing autodoc directives to document modules
and packages.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/273">#273</a>: Add an API for adding full-text search support for languages
other than English. Add support for Japanese.</p></li>
</ul>
</li>
<li><p>Markup:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/138">#138</a>: Added an <a class="reference internal" href="usage/restructuredtext/directives.html#role-index" title="index role"><code class="xref rst rst-role docutils literal notranslate"><span class="pre">index</span></code></a> role, to make inline index entries.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/454">#454</a>: Added more index markup capabilities: marking see/seealso entries,
and main entries for a given key.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/460">#460</a>: Allowed limiting the depth of section numbers for HTML using the
<a class="reference internal" href="usage/restructuredtext/directives.html#directive-toctree" title="toctree directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">toctree</span></code></a>'s <code class="docutils literal notranslate"><span class="pre">numbered</span></code> option.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/586">#586</a>: Implemented improved <a class="reference internal" href="usage/restructuredtext/directives.html#directive-glossary" title="glossary directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">glossary</span></code></a> markup which allows
multiple terms per definition.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/478">#478</a>: Added <a class="reference internal" href="usage/restructuredtext/domains.html#directive-py-decorator" title="py:decorator directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">py:decorator</span></code></a> directive to describe decorators.</p></li>
<li><p>C++ domain now supports array definitions.</p></li>
<li><p>C++ domain now supports doc fields (<code class="docutils literal notranslate"><span class="pre">:param</span> <span class="pre">x:</span></code> inside directives).</p></li>
<li><p>Section headings in <a class="reference internal" href="usage/restructuredtext/directives.html#directive-only" title="only directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">only</span></code></a> directives are now correctly
handled.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">emphasize-lines</span></code> option to source code directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/678">#678</a>: C++ domain now supports superclasses.</p></li>
</ul>
</li>
<li><p>HTML builder:</p>
<ul>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">pyramid</span></code> theme.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/559">#559</a>: <code class="docutils literal notranslate"><span class="pre">html_add_permalinks</span></code> is now a string giving the
text to display in permalinks.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/259">#259</a>: HTML table rows now have even/odd CSS classes to enable
“Zebra styling”.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/554">#554</a>: Add theme option <code class="docutils literal notranslate"><span class="pre">sidebarwidth</span></code> to the basic theme.</p></li>
</ul>
</li>
<li><p>Other builders:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/516">#516</a>: Added new value of the <a class="reference internal" href="usage/configuration.html#confval-latex_show_urls"><code class="xref std std-confval docutils literal notranslate"><span class="pre">latex_show_urls</span></code></a> option to
show the URLs in footnotes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/209">#209</a>: Added <a class="reference internal" href="usage/configuration.html#confval-text_newlines"><code class="xref std std-confval docutils literal notranslate"><span class="pre">text_newlines</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-text_sectionchars"><code class="xref std std-confval docutils literal notranslate"><span class="pre">text_sectionchars</span></code></a>
config values.</p></li>
<li><p>Added <a class="reference internal" href="usage/configuration.html#confval-man_show_urls"><code class="xref std std-confval docutils literal notranslate"><span class="pre">man_show_urls</span></code></a> config value.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/472">#472</a>: linkcheck builder: Check links in parallel, use HTTP HEAD
requests and allow configuring the timeout. New config values:
<a class="reference internal" href="usage/configuration.html#confval-linkcheck_timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_timeout</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-linkcheck_workers"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_workers</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/521">#521</a>: Added <a class="reference internal" href="usage/configuration.html#confval-linkcheck_ignore"><code class="xref std std-confval docutils literal notranslate"><span class="pre">linkcheck_ignore</span></code></a> config value.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/28">#28</a>: Support row/colspans in tables in the LaTeX builder.</p></li>
</ul>
</li>
<li><p>Configuration and extensibility:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/537">#537</a>: Added <a class="reference internal" href="usage/configuration.html#confval-nitpick_ignore"><code class="xref std std-confval docutils literal notranslate"><span class="pre">nitpick_ignore</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/306">#306</a>: Added <a class="reference internal" href="extdev/appapi.html#event-env-get-outdated"><code class="xref std std-event docutils literal notranslate"><span class="pre">env-get-outdated</span></code></a> event.</p></li>
<li><p><code class="xref py py-meth docutils literal notranslate"><span class="pre">Application.add_stylesheet()</span></code> now accepts full URIs.</p></li>
</ul>
</li>
<li><p>Autodoc:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/564">#564</a>: Add <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_docstring_signature"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autodoc_docstring_signature</span></code></a>. When enabled (the
default), autodoc retrieves the signature from the first line of the
docstring, if it is found there.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/176">#176</a>: Provide <code class="docutils literal notranslate"><span class="pre">private-members</span></code> option for autodoc directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/520">#520</a>: Provide <code class="docutils literal notranslate"><span class="pre">special-members</span></code> option for autodoc directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/431">#431</a>: Doc comments for attributes can now be given on the same line
as the assignment.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/437">#437</a>: autodoc now shows values of class data attributes.</p></li>
<li><p>autodoc now supports documenting the signatures of
<code class="docutils literal notranslate"><span class="pre">functools.partial</span></code> objects.</p></li>
</ul>
</li>
<li><p>Other extensions:</p>
<ul>
<li><p>Added the <a class="reference internal" href="usage/extensions/math.html#module-sphinx.ext.mathjax" title="sphinx.ext.mathjax: Render math using JavaScript via MathJax."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sphinx.ext.mathjax</span></code></a> extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/443">#443</a>: Allow referencing external graphviz files.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">inline</span></code> option to graphviz directives, and fixed the
default (block-style) in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/590">#590</a>: Added <code class="docutils literal notranslate"><span class="pre">caption</span></code> option to graphviz directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/553">#553</a>: Added <a class="reference internal" href="usage/extensions/doctest.html#directive-testcleanup" title="testcleanup directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">testcleanup</span></code></a> blocks in the doctest extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/594">#594</a>: <a class="reference internal" href="usage/configuration.html#confval-trim_doctest_flags"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">trim_doctest_flags</span></code></a> now also removes <code class="docutils literal notranslate"><span class="pre"><BLANKLINE></span></code>
indicators.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/367">#367</a>: Added automatic exclusion of hidden members in inheritance
diagrams, and an option to selectively enable it.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">pngmath_add_tooltips</span></code>.</p></li>
<li><p>The math extension displaymath directives now support <code class="docutils literal notranslate"><span class="pre">name</span></code> in
addition to <code class="docutils literal notranslate"><span class="pre">label</span></code> for giving the equation label, for compatibility
with Docutils.</p></li>
</ul>
</li>
<li><p>New locales:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/221">#221</a>: Added Swedish locale.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/526">#526</a>: Added Iranian locale.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/694">#694</a>: Added Latvian locale.</p></li>
<li><p>Added Nepali locale.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/714">#714</a>: Added Korean locale.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/766">#766</a>: Added Estonian locale.</p></li>
</ul>
</li>
<li><p>Bugs fixed:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/778">#778</a>: Fix “hide search matches” link on pages linked by search.</p></li>
<li><p>Fix the source positions referenced by the “viewcode” extension.</p></li>
</ul>
</li>
</ul>
</section>
</section>
<section id="release-1-0-8-sep-23-2011">
<h2>Release 1.0.8 (Sep 23, 2011)<a class="headerlink" href="#release-1-0-8-sep-23-2011" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/627">#627</a>: Fix tracebacks for AttributeErrors in autosummary generation.</p></li>
<li><p>Fix the <code class="docutils literal notranslate"><span class="pre">abbr</span></code> role when the abbreviation has newlines in it.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/727">#727</a>: Fix the links to search results with custom object types.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/648">#648</a>: Fix line numbers reported in warnings about undefined
references.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/696">#696</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/666">#666</a>: Fix C++ array definitions and template arguments
that are not type names.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/633">#633</a>: Allow footnotes in section headers in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/616">#616</a>: Allow keywords to be linked via intersphinx.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/613">#613</a>: Allow Unicode characters in production list token names.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/720">#720</a>: Add dummy visitors for graphviz nodes for text and man.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/704">#704</a>: Fix image file duplication bug.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/677">#677</a>: Fix parsing of multiple signatures in C++ domain.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/637">#637</a>: Ignore Emacs lock files when looking for source files.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/544">#544</a>: Allow .pyw extension for importable modules in autodoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/700">#700</a>: Use <code class="docutils literal notranslate"><span class="pre">$(MAKE)</span></code> in quickstart-generated Makefiles.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/734">#734</a>: Make sidebar search box width consistent in browsers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/644">#644</a>: Fix spacing of centered figures in HTML output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/767">#767</a>: Safely encode SphinxError messages when printing them to
sys.stderr.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/611">#611</a>: Fix LaTeX output error with a document with no sections but
a link target.</p></li>
<li><p>Correctly treat built-in method descriptors as methods in autodoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/706">#706</a>: Stop monkeypatching the Python textwrap module.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/657">#657</a>: viewcode now works correctly with source files that have
non-ASCII encoding.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/669">#669</a>: Respect the <code class="docutils literal notranslate"><span class="pre">noindex</span></code> flag option in py:module directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/675">#675</a>: Fix IndexErrors when including nonexisting lines with
<a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/676">#676</a>: Respect custom function/method parameter separator strings.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/682">#682</a>: Fix JS incompatibility with jQuery >= 1.5.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/693">#693</a>: Fix double encoding done when writing HTMLHelp .hhk files.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/647">#647</a>: Do not apply SmartyPants in parsed-literal blocks.</p></li>
<li><p>C++ domain now supports array definitions.</p></li>
</ul>
</section>
<section id="release-1-0-7-jan-15-2011">
<h2>Release 1.0.7 (Jan 15, 2011)<a class="headerlink" href="#release-1-0-7-jan-15-2011" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/347">#347</a>: Fix wrong generation of directives of static methods in
autosummary.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/599">#599</a>: Import PIL as <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">PIL</span> <span class="pre">import</span> <span class="pre">Image</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/558">#558</a>: Fix longtables with captions in LaTeX output.</p></li>
<li><p>Make token references work as hyperlinks again in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/572">#572</a>: Show warnings by default when reference labels cannot be
found.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/536">#536</a>: Include line number when complaining about missing reference
targets in nitpicky mode.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/590">#590</a>: Fix inline display of graphviz diagrams in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/589">#589</a>: Build using app.build() in setup command.</p></li>
<li><p>Fix a bug in the inheritance diagram exception that caused base
classes to be skipped if one of them is a builtin.</p></li>
<li><p>Fix general index links for C++ domain objects.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/332">#332</a>: Make admonition boundaries in LaTeX output visible.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/573">#573</a>: Fix KeyErrors occurring on rebuild after removing a file.</p></li>
<li><p>Fix a traceback when removing files with globbed toctrees.</p></li>
<li><p>If an autodoc object cannot be imported, always re-read the
document containing the directive on next build.</p></li>
<li><p>If an autodoc object cannot be imported, show the full traceback
of the import error.</p></li>
<li><p>Fix a bug where the removal of download files and images wasn’t
noticed.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/571">#571</a>: Implement <code class="docutils literal notranslate"><span class="pre">~</span></code> cross-reference prefix for the C domain.</p></li>
<li><p>Fix regression of LaTeX output with the fix of <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/556">#556</a>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/568">#568</a>: Fix lookup of class attribute documentation on descriptors
so that comment documentation now works.</p></li>
<li><p>Fix traceback with <code class="docutils literal notranslate"><span class="pre">only</span></code> directives preceded by targets.</p></li>
<li><p>Fix tracebacks occurring for duplicate C++ domain objects.</p></li>
<li><p>Fix JavaScript domain links to objects with <code class="docutils literal notranslate"><span class="pre">$</span></code> in their name.</p></li>
</ul>
</section>
<section id="release-1-0-6-jan-04-2011">
<h2>Release 1.0.6 (Jan 04, 2011)<a class="headerlink" href="#release-1-0-6-jan-04-2011" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/581">#581</a>: Fix traceback in Python domain for empty cross-reference
targets.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/283">#283</a>: Fix literal block display issues on Chrome browsers.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/383">#383</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/148">#148</a>: Support sorting a limited range of accented characters
in the general index and the glossary.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/570">#570</a>: Try decoding <code class="docutils literal notranslate"><span class="pre">-D</span></code> and <code class="docutils literal notranslate"><span class="pre">-A</span></code> command-line arguments with
the locale’s preferred encoding.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/528">#528</a>: Observe <a class="reference internal" href="usage/configuration.html#confval-locale_dirs"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">locale_dirs</span></code></a> when looking for the JS
translations file.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/574">#574</a>: Add special code for better support of Japanese documents
in the LaTeX builder.</p></li>
<li><p>Regression of <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/77">#77</a>: If there is only one parameter given with
<code class="docutils literal notranslate"><span class="pre">:param:</span></code> markup, the bullet list is now suppressed again.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/556">#556</a>: Fix missing paragraph breaks in LaTeX output in certain
situations.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/567">#567</a>: Emit the <code class="docutils literal notranslate"><span class="pre">autodoc-process-docstring</span></code> event even for objects
without a docstring so that it can add content.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/565">#565</a>: In the LaTeX builder, not only literal blocks require different
table handling, but also quite a few other list-like block elements.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/515">#515</a>: Fix tracebacks in the viewcode extension for Python objects
that do not have a valid signature.</p></li>
<li><p>Fix strange reports of line numbers for warnings generated from
autodoc-included docstrings, due to different behavior depending
on docutils version.</p></li>
<li><p>Several fixes to the C++ domain.</p></li>
</ul>
</section>
<section id="release-1-0-5-nov-12-2010">
<h2>Release 1.0.5 (Nov 12, 2010)<a class="headerlink" href="#release-1-0-5-nov-12-2010" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/557">#557</a>: Add CSS styles required by docutils 0.7 for aligned images
and figures.</p></li>
<li><p>In the Makefile generated by LaTeX output, do not delete pdf files
on clean; they might be required images.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/535">#535</a>: Fix LaTeX output generated for line blocks.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/544">#544</a>: Allow <code class="docutils literal notranslate"><span class="pre">.pyw</span></code> as a source file extension.</p></li>
</ul>
</section>
<section id="release-1-0-4-sep-17-2010">
<h2>Release 1.0.4 (Sep 17, 2010)<a class="headerlink" href="#release-1-0-4-sep-17-2010" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/524">#524</a>: Open intersphinx inventories in binary mode on Windows,
since version 2 contains zlib-compressed data.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/513">#513</a>: Allow giving non-local URIs for JavaScript files, e.g.
in the JSMath extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/512">#512</a>: Fix traceback when <code class="docutils literal notranslate"><span class="pre">intersphinx_mapping</span></code> is empty.</p></li>
</ul>
</section>
<section id="release-1-0-3-aug-23-2010">
<h2>Release 1.0.3 (Aug 23, 2010)<a class="headerlink" href="#release-1-0-3-aug-23-2010" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/495">#495</a>: Fix internal vs. external link distinction for links coming
from a docutils table-of-contents.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/494">#494</a>: Fix the <code class="docutils literal notranslate"><span class="pre">maxdepth</span></code> option for the <code class="docutils literal notranslate"><span class="pre">toctree()</span></code> template
callable when used with <code class="docutils literal notranslate"><span class="pre">collapse=True</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/507">#507</a>: Fix crash parsing Python argument lists containing brackets
in string literals.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/501">#501</a>: Fix regression when building LaTeX docs with figures that
don’t have captions.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/510">#510</a>: Fix inheritance diagrams for classes that are not picklable.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/497">#497</a>: Introduce separate background color for the sidebar collapse
button, making it easier to see.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/502">#502</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/503">#503</a>, <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/496">#496</a>: Fix small layout bugs in several builtin themes.</p></li>
</ul>
</section>
<section id="release-1-0-2-aug-14-2010">
<h2>Release 1.0.2 (Aug 14, 2010)<a class="headerlink" href="#release-1-0-2-aug-14-2010" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/490">#490</a>: Fix cross-references to objects of types added by the
<a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.add_object_type" title="sphinx.application.Sphinx.add_object_type"><code class="xref py py-func docutils literal notranslate"><span class="pre">add_object_type()</span></code></a> API function.</p></li>
<li><p>Fix handling of doc field types for different directive types.</p></li>
<li><p>Allow breaking long signatures, continuing with backlash-escaped
newlines.</p></li>
<li><p>Fix unwanted styling of C domain references (because of a namespace
clash with Pygments styles).</p></li>
<li><p>Allow references to PEPs and RFCs with explicit anchors.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/471">#471</a>: Fix LaTeX references to figures.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/482">#482</a>: When doing a non-exact search, match only the given type
of object.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/481">#481</a>: Apply non-exact search for Python reference targets with
<code class="docutils literal notranslate"><span class="pre">.name</span></code> for modules too.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/484">#484</a>: Fix crash when duplicating a parameter in an info field list.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/487">#487</a>: Fix setting the default role to one provided by the
<code class="docutils literal notranslate"><span class="pre">oldcmarkup</span></code> extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/488">#488</a>: Fix crash when json-py is installed, which provides a
<code class="docutils literal notranslate"><span class="pre">json</span></code> module but is incompatible to simplejson.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/480">#480</a>: Fix handling of target naming in intersphinx.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/486">#486</a>: Fix removal of <code class="docutils literal notranslate"><span class="pre">!</span></code> for all cross-reference roles.</p></li>
</ul>
</section>
<section id="release-1-0-1-jul-27-2010">
<h2>Release 1.0.1 (Jul 27, 2010)<a class="headerlink" href="#release-1-0-1-jul-27-2010" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/470">#470</a>: Fix generated target names for reST domain objects; they
are not in the same namespace.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/266">#266</a>: Add Bengali language.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/473">#473</a>: Fix a bug in parsing JavaScript object names.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/474">#474</a>: Fix building with SingleHTMLBuilder when there is no toctree.</p></li>
<li><p>Fix display names for objects linked to by intersphinx with
explicit targets.</p></li>
<li><p>Fix building with the JSON builder.</p></li>
<li><p>Fix hyperrefs in object descriptions for LaTeX.</p></li>
</ul>
</section>
<section id="release-1-0-jul-23-2010">
<h2>Release 1.0 (Jul 23, 2010)<a class="headerlink" href="#release-1-0-jul-23-2010" title="Link to this heading">¶</a></h2>
<section id="id3086">
<h3>Incompatible changes<a class="headerlink" href="#id3086" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Support for domains has been added. A domain is a collection of
directives and roles that all describe objects belonging together,
e.g. elements of a programming language. A few builtin domains are
provided:</p>
<ul>
<li><p>Python</p></li>
<li><p>C</p></li>
<li><p>C++</p></li>
<li><p>JavaScript</p></li>
<li><p>reStructuredText</p></li>
</ul>
</li>
<li><p>The old markup for defining and linking to C directives is now
deprecated. It will not work anymore in future versions without
activating the <code class="docutils literal notranslate"><span class="pre">oldcmarkup</span></code> extension; in Sphinx
1.0, it is activated by default.</p></li>
<li><p>Removed support for old dependency versions; requirements are now:</p>
<ul>
<li><p>docutils >= 0.5</p></li>
<li><p>Jinja2 >= 2.2</p></li>
</ul>
</li>
<li><p>Removed deprecated elements:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">exclude_dirs</span></code> config value</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx.builder</span></code> module</p></li>
</ul>
</li>
</ul>
</section>
<section id="id3087">
<h3>Features added<a class="headerlink" href="#id3087" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>General:</p>
<ul>
<li><p>Added a “nitpicky” mode that emits warnings for all missing
references. It is activated by the <a class="reference internal" href="man/sphinx-build.html#cmdoption-sphinx-build-n"><code class="xref std std-option docutils literal notranslate"><span class="pre">sphinx-build</span> <span class="pre">-n</span></code></a> command-line
switch or the <a class="reference internal" href="usage/configuration.html#confval-nitpicky"><code class="xref std std-confval docutils literal notranslate"><span class="pre">nitpicky</span></code></a> config value.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">latexpdf</span></code> target in quickstart Makefile.</p></li>
</ul>
</li>
<li><p>Markup:</p>
<ul>
<li><p>The <a class="reference internal" href="usage/restructuredtext/roles.html#role-menuselection" title="menuselection role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">menuselection</span></code></a> and <a class="reference internal" href="usage/restructuredtext/roles.html#role-guilabel" title="guilabel role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">guilabel</span></code></a> roles now
support ampersand accelerators.</p></li>
<li><p>New more compact doc field syntax is now recognized: <code class="docutils literal notranslate"><span class="pre">:param</span> <span class="pre">type</span>
<span class="pre">name:</span> <span class="pre">description</span></code>.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">tab-width</span></code> option to <a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> directive.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">titlesonly</span></code> option to <a class="reference internal" href="usage/restructuredtext/directives.html#directive-toctree" title="toctree directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">toctree</span></code></a> directive.</p></li>
<li><p>Added the <code class="docutils literal notranslate"><span class="pre">prepend</span></code> and <code class="docutils literal notranslate"><span class="pre">append</span></code> options to the
<a class="reference internal" href="usage/restructuredtext/directives.html#directive-literalinclude" title="literalinclude directive"><code class="xref any rst rst-dir docutils literal notranslate"><span class="pre">literalinclude</span></code></a> directive.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/284">#284</a>: All docinfo metadata is now put into the document metadata, not
just the author.</p></li>
<li><p>The <a class="reference internal" href="usage/restructuredtext/roles.html#role-ref" title="ref role"><code class="xref any rst rst-role docutils literal notranslate"><span class="pre">ref</span></code></a> role can now also reference tables by caption.</p></li>
<li><p>The <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#include">include</a> directive now supports absolute paths, which
are interpreted as relative to the source directory.</p></li>
<li><p>In the Python domain, references like <code class="docutils literal notranslate"><span class="pre">:func:`.name`</span></code> now look for
matching names with any prefix if no direct match is found.</p></li>
</ul>
</li>
<li><p>Configuration:</p>
<ul>
<li><p>Added <a class="reference internal" href="usage/configuration.html#confval-rst_prolog"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">rst_prolog</span></code></a> config value.</p></li>
<li><p>Added <a class="reference internal" href="usage/configuration.html#confval-html_secnumber_suffix"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_secnumber_suffix</span></code></a> config value to control
section numbering format.</p></li>
<li><p>Added <a class="reference internal" href="usage/configuration.html#confval-html_compact_lists"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_compact_lists</span></code></a> config value to control
docutils’ compact lists feature.</p></li>
<li><p>The <a class="reference internal" href="usage/configuration.html#confval-html_sidebars"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_sidebars</span></code></a> config value can now contain patterns
as keys, and the values can be lists that explicitly select which
sidebar templates should be rendered. That means that the builtin
sidebar contents can be included only selectively.</p></li>
<li><p><a class="reference internal" href="usage/configuration.html#confval-html_static_path"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_static_path</span></code></a> can now contain single file entries.</p></li>
<li><p>The new universal config value <a class="reference internal" href="usage/configuration.html#confval-exclude_patterns"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">exclude_patterns</span></code></a> makes the
old <code class="docutils literal notranslate"><span class="pre">unused_docs</span></code>, <code class="docutils literal notranslate"><span class="pre">exclude_trees</span></code> and
<code class="docutils literal notranslate"><span class="pre">exclude_dirnames</span></code> obsolete.</p></li>
<li><p>Added <a class="reference internal" href="usage/configuration.html#confval-html_output_encoding"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_output_encoding</span></code></a> config value.</p></li>
<li><p>Added the <a class="reference internal" href="usage/configuration.html#confval-latex_docclass"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_docclass</span></code></a> config value and made the
“twoside” documentclass option overridable by “oneside”.</p></li>
<li><p>Added the <a class="reference internal" href="usage/configuration.html#confval-trim_doctest_flags"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">trim_doctest_flags</span></code></a> config value, which is true
by default.</p></li>
<li><p>Added <a class="reference internal" href="usage/configuration.html#confval-html_show_copyright"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_show_copyright</span></code></a> config value.</p></li>
<li><p>Added <a class="reference internal" href="usage/configuration.html#confval-latex_show_pagerefs"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_show_pagerefs</span></code></a> and <a class="reference internal" href="usage/configuration.html#confval-latex_show_urls"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">latex_show_urls</span></code></a>
config values.</p></li>
<li><p>The behavior of <a class="reference internal" href="usage/configuration.html#confval-html_file_suffix"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">html_file_suffix</span></code></a> changed slightly: the
empty string now means “no suffix” instead of “default suffix”, use
<code class="docutils literal notranslate"><span class="pre">None</span></code> for “default suffix”.</p></li>
</ul>
</li>
<li><p>New builders:</p>
<ul>
<li><p>Added a builder for the Epub format.</p></li>
<li><p>Added a builder for manual pages.</p></li>
<li><p>Added a single-file HTML builder.</p></li>
</ul>
</li>
<li><p>HTML output:</p>
<ul>
<li><p>Inline roles now get a CSS class with their name, allowing styles to
customize their appearance. Domain-specific roles get two classes,
<code class="docutils literal notranslate"><span class="pre">domain</span></code> and <code class="docutils literal notranslate"><span class="pre">domain-rolename</span></code>.</p></li>
<li><p>References now get the class <code class="docutils literal notranslate"><span class="pre">internal</span></code> if they are internal to
the whole project, as opposed to internal to the current page.</p></li>
<li><p>External references can be styled differently with the new
<code class="docutils literal notranslate"><span class="pre">externalrefs</span></code> theme option for the default theme.</p></li>
<li><p>In the default theme, the sidebar can experimentally now be made
collapsible using the new <code class="docutils literal notranslate"><span class="pre">collapsiblesidebar</span></code> theme option.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/129">#129</a>: Toctrees are now wrapped in a <code class="docutils literal notranslate"><span class="pre">div</span></code> tag with class
<code class="docutils literal notranslate"><span class="pre">toctree-wrapper</span></code> in HTML output.</p></li>
<li><p>The <a class="reference internal" href="development/templating.html#toctree" title="toctree"><code class="xref py py-data docutils literal notranslate"><span class="pre">toctree</span></code></a> callable in templates now has a <code class="docutils literal notranslate"><span class="pre">maxdepth</span></code>
keyword argument to control the depth of the generated tree.</p></li>
<li><p>The <a class="reference internal" href="development/templating.html#toctree" title="toctree"><code class="xref py py-data docutils literal notranslate"><span class="pre">toctree</span></code></a> callable in templates now accepts a
<code class="docutils literal notranslate"><span class="pre">titles_only</span></code> keyword argument.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">htmltitle</span></code> block in layout template.</p></li>
<li><p>In the JavaScript search, allow searching for object names including
the module name, like <code class="docutils literal notranslate"><span class="pre">sys.argv</span></code>.</p></li>
<li><p>Added new theme <code class="docutils literal notranslate"><span class="pre">haiku</span></code>, inspired by the Haiku OS user guide.</p></li>
<li><p>Added new theme <code class="docutils literal notranslate"><span class="pre">nature</span></code>.</p></li>
<li><p>Added new theme <code class="docutils literal notranslate"><span class="pre">agogo</span></code>, created by Andi Albrecht.</p></li>
<li><p>Added new theme <code class="docutils literal notranslate"><span class="pre">scrolls</span></code>, created by Armin Ronacher.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/193">#193</a>: Added a <code class="docutils literal notranslate"><span class="pre">visitedlinkcolor</span></code> theme option to the default
theme.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/322">#322</a>: Improved responsiveness of the search page by loading the
search index asynchronously.</p></li>
</ul>
</li>
<li><p>Extension API:</p>
<ul>
<li><p>Added <a class="reference internal" href="extdev/appapi.html#event-html-collect-pages"><code class="xref std std-event docutils literal notranslate"><span class="pre">html-collect-pages</span></code></a>.</p></li>
<li><p>Added <a class="reference internal" href="usage/configuration.html#confval-needs_sphinx"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">needs_sphinx</span></code></a> config value and
<a class="reference internal" href="extdev/appapi.html#sphinx.application.Sphinx.require_sphinx" title="sphinx.application.Sphinx.require_sphinx"><code class="xref py py-meth docutils literal notranslate"><span class="pre">require_sphinx()</span></code></a> application API
method.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/200">#200</a>: Added <code class="xref py py-meth docutils literal notranslate"><span class="pre">add_stylesheet()</span></code>
application API method.</p></li>
</ul>
</li>
<li><p>Extensions:</p>
<ul>
<li><p>Added the <a class="reference internal" href="usage/extensions/viewcode.html#module-sphinx.ext.viewcode" title="sphinx.ext.viewcode: Add links to a highlighted version of the source code."><code class="xref py py-mod docutils literal notranslate"><span class="pre">viewcode</span></code></a> extension.</p></li>
<li><p>Added the <a class="reference internal" href="usage/extensions/extlinks.html#module-sphinx.ext.extlinks" title="sphinx.ext.extlinks: Allow inserting external links with common base URLs easily."><code class="xref py py-mod docutils literal notranslate"><span class="pre">extlinks</span></code></a> extension.</p></li>
<li><p>Added support for source ordering of members in autodoc, with
<code class="docutils literal notranslate"><span class="pre">autodoc_member_order</span> <span class="pre">=</span> <span class="pre">'bysource'</span></code>.</p></li>
<li><p>Added <a class="reference internal" href="usage/extensions/autodoc.html#confval-autodoc_default_flags"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">autodoc_default_flags</span></code></a> config value, which can be
used to select default flags for all autodoc directives.</p></li>
<li><p>Added a way for intersphinx to refer to named labels in other
projects, and to specify the project you want to link to.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/280">#280</a>: Autodoc can now document instance attributes assigned in
<code class="docutils literal notranslate"><span class="pre">__init__</span></code> methods.</p></li>
<li><p>Many improvements and fixes to the <a class="reference internal" href="usage/extensions/autosummary.html#module-sphinx.ext.autosummary" title="sphinx.ext.autosummary: Generate autodoc summaries"><code class="xref py py-mod docutils literal notranslate"><span class="pre">autosummary</span></code></a>
extension, thanks to Pauli Virtanen.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/309">#309</a>: The <a class="reference internal" href="usage/extensions/graphviz.html#module-sphinx.ext.graphviz" title="sphinx.ext.graphviz: Support for Graphviz graphs."><code class="xref py py-mod docutils literal notranslate"><span class="pre">graphviz</span></code></a> extension can now output SVG
instead of PNG images, controlled by the
<a class="reference internal" href="usage/extensions/graphviz.html#confval-graphviz_output_format"><code class="xref any std std-confval docutils literal notranslate"><span class="pre">graphviz_output_format</span></code></a> config value.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">alt</span></code> option to <a class="reference internal" href="usage/extensions/graphviz.html#directive-graphviz" title="graphviz directive"><code class="xref rst rst-dir docutils literal notranslate"><span class="pre">graphviz</span></code></a> extension directives.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">exclude</span></code> argument to <a class="reference internal" href="usage/extensions/autodoc.html#sphinx.ext.autodoc.between" title="sphinx.ext.autodoc.between"><code class="xref py py-func docutils literal notranslate"><span class="pre">autodoc.between()</span></code></a>.</p></li>
</ul>
</li>
<li><p>Translations:</p>
<ul>
<li><p>Added Croatian translation, thanks to Bojan Mihelač.</p></li>
<li><p>Added Turkish translation, thanks to Firat Ozgul.</p></li>
<li><p>Added Catalan translation, thanks to Pau Fernández.</p></li>
<li><p>Added simplified Chinese translation.</p></li>
<li><p>Added Danish translation, thanks to Hjorth Larsen.</p></li>
<li><p>Added Lithuanian translation, thanks to Dalius Dobravolskas.</p></li>
</ul>
</li>
<li><p>Bugs fixed:</p>
<ul>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/445">#445</a>: Fix links to result pages when using the search function
of HTML built with the <code class="docutils literal notranslate"><span class="pre">dirhtml</span></code> builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/444">#444</a>: In templates, properly re-escape values treated with the
“striptags” Jinja filter.</p></li>
</ul>
</li>
</ul>
</section>
</section>
<section id="release-0-6-7-jun-05-2010">
<h2>Release 0.6.7 (Jun 05, 2010)<a class="headerlink" href="#release-0-6-7-jun-05-2010" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/440">#440</a>: Remove usage of a Python >= 2.5 API in the <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code>
directive.</p></li>
<li><p>Fix a bug that prevented some references being generated in the
LaTeX builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/428">#428</a>: Add some missing CSS styles for standard docutils classes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/432">#432</a>: Fix UnicodeErrors while building LaTeX in translated locale.</p></li>
</ul>
</section>
<section id="release-0-6-6-may-25-2010">
<h2>Release 0.6.6 (May 25, 2010)<a class="headerlink" href="#release-0-6-6-may-25-2010" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Handle raw nodes in the <code class="docutils literal notranslate"><span class="pre">text</span></code> writer.</p></li>
<li><p>Fix a problem the Qt help project generated by the <code class="docutils literal notranslate"><span class="pre">qthelp</span></code>
builder that would lead to no content being displayed in the Qt
Assistant.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/393">#393</a>: Fix the usage of Unicode characters in mathematic formulas
when using the <code class="docutils literal notranslate"><span class="pre">pngmath</span></code> extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/404">#404</a>: Make <code class="docutils literal notranslate"><span class="pre">\and</span></code> work properly in the author field of the
<code class="docutils literal notranslate"><span class="pre">latex_documents</span></code> setting.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/409">#409</a>: Make the <code class="docutils literal notranslate"><span class="pre">highlight_language</span></code> config value work properly
in the LaTeX builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/418">#418</a>: Allow relocation of the translation JavaScript files to
the system directory on Unix systems.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/414">#414</a>: Fix handling of Windows newlines in files included with
the <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> directive.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/377">#377</a>: Fix crash in linkcheck builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/387">#387</a>: Fix the display of search results in <code class="docutils literal notranslate"><span class="pre">dirhtml</span></code> output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/376">#376</a>: In autodoc, fix display of parameter defaults containing
backslashes.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/370">#370</a>: Fix handling of complex list item labels in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/374">#374</a>: Make the <code class="docutils literal notranslate"><span class="pre">doctest_path</span></code> config value of the doctest
extension actually work.</p></li>
<li><p>Fix the handling of multiple toctrees when creating the global
TOC for the <code class="docutils literal notranslate"><span class="pre">toctree()</span></code> template function.</p></li>
<li><p>Fix the handling of hidden toctrees when creating the global TOC
for the <code class="docutils literal notranslate"><span class="pre">toctree()</span></code> template function.</p></li>
<li><p>Fix the handling of nested lists in the text writer.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/362">#362</a>: In autodoc, check for the existence of <code class="docutils literal notranslate"><span class="pre">__self__</span></code> on
function objects before accessing it.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/353">#353</a>: Strip leading and trailing whitespace when extracting
search words in the search function.</p></li>
</ul>
</section>
<section id="release-0-6-5-mar-01-2010">
<h2>Release 0.6.5 (Mar 01, 2010)<a class="headerlink" href="#release-0-6-5-mar-01-2010" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>In autodoc, fix the omission of some module members explicitly
documented using documentation comments.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/345">#345</a>: Fix cropping of sidebar scroll bar with <code class="docutils literal notranslate"><span class="pre">stickysidebar</span></code>
option of the default theme.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/341">#341</a>: Always generate UNIX newlines in the quickstart Makefile.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/338">#338</a>: Fix running with <code class="docutils literal notranslate"><span class="pre">-C</span></code> under Windows.</p></li>
<li><p>In autodoc, allow customizing the signature of an object where
the built-in mechanism fails.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/331">#331</a>: Fix output for enumerated lists with start values in LaTeX.</p></li>
<li><p>Make the <code class="docutils literal notranslate"><span class="pre">start-after</span></code> and <code class="docutils literal notranslate"><span class="pre">end-before</span></code> options to the
<code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> directive work correctly if not used together.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/321">#321</a>: Fix link generation in the LaTeX builder.</p></li>
</ul>
</section>
<section id="release-0-6-4-jan-12-2010">
<h2>Release 0.6.4 (Jan 12, 2010)<a class="headerlink" href="#release-0-6-4-jan-12-2010" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Improve the handling of non-Unicode strings in the configuration.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/316">#316</a>: Catch OSErrors occurring when calling graphviz with
arguments it doesn’t understand.</p></li>
<li><p>Restore compatibility with Pygments >= 1.2.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/295">#295</a>: Fix escaping of hyperref targets in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/302">#302</a>: Fix links generated by the <code class="docutils literal notranslate"><span class="pre">:doc:</span></code> role for LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/286">#286</a>: collect todo nodes after the whole document has been read;
this allows placing substitution references in todo items.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/294">#294</a>: do not ignore an explicit <code class="docutils literal notranslate"><span class="pre">today</span></code> config value in a
LaTeX build.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">alt</span></code> text of inheritance diagrams is now much cleaner.</p></li>
<li><p>Ignore images in section titles when generating link captions.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/310">#310</a>: support exception messages in the <code class="docutils literal notranslate"><span class="pre">testoutput</span></code> blocks of
the <code class="docutils literal notranslate"><span class="pre">doctest</span></code> extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/293">#293</a>: line blocks are styled properly in HTML output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/285">#285</a>: make the <code class="docutils literal notranslate"><span class="pre">locale_dirs</span></code> config value work again.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/303">#303</a>: <code class="docutils literal notranslate"><span class="pre">html_context</span></code> values given on the command line via <code class="docutils literal notranslate"><span class="pre">-A</span></code>
should not override other values given in conf.py.</p></li>
<li><p>Fix a bug preventing incremental rebuilds for the <code class="docutils literal notranslate"><span class="pre">dirhtml</span></code>
builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/299">#299</a>: Fix the mangling of quotes in some literal blocks.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/292">#292</a>: Fix path to the search index for the <code class="docutils literal notranslate"><span class="pre">dirhtml</span></code> builder.</p></li>
<li><p>Fix a Jython compatibility issue: make the dependence on the
<code class="docutils literal notranslate"><span class="pre">parser</span></code> module optional.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/238">#238</a>: In autodoc, catch all errors that occur on module import,
not just <code class="docutils literal notranslate"><span class="pre">ImportError</span></code>.</p></li>
<li><p>Fix the handling of non-data, but non-method descriptors in autodoc.</p></li>
<li><p>When copying file times, ignore OSErrors raised by <code class="docutils literal notranslate"><span class="pre">os.utime()</span></code>.</p></li>
</ul>
</section>
<section id="release-0-6-3-sep-03-2009">
<h2>Release 0.6.3 (Sep 03, 2009)<a class="headerlink" href="#release-0-6-3-sep-03-2009" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Properly add C module filenames as dependencies in autodoc.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/253">#253</a>: Ignore graphviz directives without content instead of
raising an unhandled exception.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/241">#241</a>: Fix a crash building LaTeX output for documents that contain
a todolist directive.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/252">#252</a>: Make it easier to change the build dir in the Makefiles
generated by quickstart.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/220">#220</a>: Fix CSS so that displaymath really is centered.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/222">#222</a>: Allow the “Footnotes” header to be translated.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/225">#225</a>: Don’t add whitespace in generated HTML after inline tags.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/227">#227</a>: Make <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> work when the document’s path
name contains non-ASCII characters.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/229">#229</a>: Fix autodoc failures with members that raise errors
on <code class="docutils literal notranslate"><span class="pre">getattr()</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/205">#205</a>: When copying files, don’t copy full stat info, only
modification times.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/232">#232</a>: Support non-ASCII metadata in Qt help builder.</p></li>
<li><p>Properly format bullet lists nested in definition lists for LaTeX.</p></li>
<li><p>Section titles are now allowed inside <code class="docutils literal notranslate"><span class="pre">only</span></code> directives.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/201">#201</a>: Make <code class="docutils literal notranslate"><span class="pre">centered</span></code> directive work in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/206">#206</a>: Refuse to overwrite an existing master document in
sphinx-quickstart.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/208">#208</a>: Use MS-sanctioned locale settings, determined by the
<code class="docutils literal notranslate"><span class="pre">language</span></code> config option, in the HTML help builder.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/210">#210</a>: Fix nesting of HTML tags for displayed math from pngmath
extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/213">#213</a>: Fix centering of images in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/211">#211</a>: Fix compatibility with docutils 0.5.</p></li>
</ul>
</section>
<section id="release-0-6-2-jun-16-2009">
<h2>Release 0.6.2 (Jun 16, 2009)<a class="headerlink" href="#release-0-6-2-jun-16-2009" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/130">#130</a>: Fix obscure IndexError in doctest extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/167">#167</a>: Make glossary sorting case-independent.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/196">#196</a>: Add a warning if an extension module doesn’t have a
<code class="docutils literal notranslate"><span class="pre">setup()</span></code> function.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/158">#158</a>: Allow ‘..’ in template names, and absolute template paths;
Jinja 2 by default disables both.</p></li>
<li><p>When highlighting Python code, ignore extra indentation before
trying to parse it as Python.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/191">#191</a>: Don’t escape the tilde in URIs in LaTeX.</p></li>
<li><p>Don’t consider contents of source comments for the search index.</p></li>
<li><p>Set the default encoding to <code class="docutils literal notranslate"><span class="pre">utf-8-sig</span></code> to handle files with a
UTF-8 BOM correctly.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/178">#178</a>: apply <code class="docutils literal notranslate"><span class="pre">add_function_parentheses</span></code> config value to C
functions as promised.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/173">#173</a>: Respect the docutils <code class="docutils literal notranslate"><span class="pre">title</span></code> directive.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/172">#172</a>: The <code class="docutils literal notranslate"><span class="pre">obj</span></code> role now links to modules as promised.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/19">#19</a>: Tables now can have a “longtable” class, in order to get
correctly broken into pages in LaTeX output.</p></li>
<li><p>Look for Sphinx message catalogs in the system default path before
trying <code class="docutils literal notranslate"><span class="pre">sphinx/locale</span></code>.</p></li>
<li><p>Fix the search for methods via “classname.methodname”.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/155">#155</a>: Fix Python 2.4 compatibility: exceptions are old-style
classes there.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/150">#150</a>: Fix display of the “sphinxdoc” theme on Internet Explorer
versions 6 and 7.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/146">#146</a>: Don’t fail to generate LaTeX when the user has an active
<code class="docutils literal notranslate"><span class="pre">.docutils</span></code> configuration.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/29">#29</a>: Don’t generate visible “-{-}” in option lists in LaTeX.</p></li>
<li><p>Fix cross-reference roles when put into substitutions.</p></li>
<li><p>Don’t put image “alt” text into table-of-contents entries.</p></li>
<li><p>In the LaTeX writer, do not raise an exception on too many section
levels, just use the “subparagraph” level for all of them.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/145">#145</a>: Fix autodoc problem with automatic members that refuse to be
getattr()’d from their parent.</p></li>
<li><p>If specific filenames to build are given on the command line,
check that they are within the source directory.</p></li>
<li><p>Fix autodoc crash for objects without a <code class="docutils literal notranslate"><span class="pre">__name__</span></code>.</p></li>
<li><p>Fix intersphinx for installations without urllib2.HTTPSHandler.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/134">#134</a>: Fix pending_xref leftover nodes when using the todolist
directive from the todo extension.</p></li>
</ul>
</section>
<section id="release-0-6-1-mar-26-2009">
<h2>Release 0.6.1 (Mar 26, 2009)<a class="headerlink" href="#release-0-6-1-mar-26-2009" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/135">#135</a>: Fix problems with LaTeX output and the graphviz extension.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/132">#132</a>: Include the autosummary “module” template in the distribution.</p></li>
</ul>
</section>
<section id="release-0-6-mar-24-2009">
<h2>Release 0.6 (Mar 24, 2009)<a class="headerlink" href="#release-0-6-mar-24-2009" title="Link to this heading">¶</a></h2>
<section id="new-features-added">
<h3>New features added<a class="headerlink" href="#new-features-added" title="Link to this heading">¶</a></h3>
<ul>
<li><p>Incompatible changes:</p>
<ul>
<li><p>Templating now requires the Jinja2 library, which is an enhanced
version of the old Jinja1 engine. Since the syntax and semantic
is largely the same, very few fixes should be necessary in
custom templates.</p></li>
<li><p>The “document” div tag has been moved out of the <code class="docutils literal notranslate"><span class="pre">layout.html</span></code>
template’s “document” block, because the closing tag was already
outside. If you overwrite this block, you need to remove your
“document” div tag as well.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">autodoc_skip_member</span></code> event now also gets to decide
whether to skip members whose name starts with underscores.
Previously, these members were always automatically skipped.
Therefore, if you handle this event, add something like this
to your event handler to restore the old behavior:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="n">name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'_'</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
</pre></div>
</div>
</li>
</ul>
</li>
<li><p>Theming support, see the new section in the documentation.</p></li>
<li><p>Markup:</p>
<ul class="simple">
<li><p>Due to popular demand, added a <code class="docutils literal notranslate"><span class="pre">:doc:</span></code> role which directly
links to another document without the need of creating a
label to which a <code class="docutils literal notranslate"><span class="pre">:ref:</span></code> could link to.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/4">#4</a>: Added a <code class="docutils literal notranslate"><span class="pre">:download:</span></code> role that marks a non-document file
for inclusion into the HTML output and links to it.</p></li>
<li><p>Added an <code class="docutils literal notranslate"><span class="pre">only</span></code> directive that can selectively include text
based on enabled “tags”. Tags can be given on the command
line. Also, the current builder output format (e.g. “html” or
“latex”) is always a defined tag.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/10">#10</a>: Added HTML section numbers, enabled by giving a
<code class="docutils literal notranslate"><span class="pre">:numbered:</span></code> flag to the <code class="docutils literal notranslate"><span class="pre">toctree</span></code> directive.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/114">#114</a>: Added an <code class="docutils literal notranslate"><span class="pre">abbr</span></code> role to markup abbreviations and
acronyms.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code> directive now supports several more
options, to include only parts of a file.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">toctree</span></code> directive now supports a <code class="docutils literal notranslate"><span class="pre">:hidden:</span></code> flag,
which will prevent links from being generated in place of
the directive – this allows you to define your document
structure, but place the links yourself.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/123">#123</a>: The <code class="docutils literal notranslate"><span class="pre">glossary</span></code> directive now supports a <code class="docutils literal notranslate"><span class="pre">:sorted:</span></code>
flag that sorts glossary entries alphabetically.</p></li>
<li><p>Paths to images, literal include files and download files
can now be absolute (like <code class="docutils literal notranslate"><span class="pre">/images/foo.png</span></code>). They are
treated as relative to the top source directory.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/52">#52</a>: There is now a <code class="docutils literal notranslate"><span class="pre">hlist</span></code> directive, creating a compact
list by placing distributing items into multiple columns.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/77">#77</a>: If a description environment with info field list only
contains one <code class="docutils literal notranslate"><span class="pre">:param:</span></code> entry, no bullet list is generated.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/6">#6</a>: Don’t generate redundant <code class="docutils literal notranslate"><span class="pre"><ul></span></code> for top-level TOC tree
items, which leads to a visual separation of TOC entries.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/23">#23</a>: Added a <code class="docutils literal notranslate"><span class="pre">classmethod</span></code> directive along with <code class="docutils literal notranslate"><span class="pre">method</span></code>
and <code class="docutils literal notranslate"><span class="pre">staticmethod</span></code>.</p></li>
<li><p>Scaled images now get a link to the unscaled version.</p></li>
<li><p>SVG images are now supported in HTML (via <code class="docutils literal notranslate"><span class="pre"><object></span></code> and
<code class="docutils literal notranslate"><span class="pre"><embed></span></code> tags).</p></li>
<li><p>Added a <code class="docutils literal notranslate"><span class="pre">toctree</span></code> callable to the templates, and the ability
to include external links in toctrees. The ‘collapse’ keyword
argument indicates whether or not to only display subitems of
the current page. (Defaults to True.)</p></li>
</ul>
</li>
<li><p>Configuration:</p>
<ul class="simple">
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">rst_epilog</span></code> can contain reST that is
appended to each source file that is read. This is the right
place for global substitutions.</p></li>
<li><p>The new <code class="docutils literal notranslate"><span class="pre">html_add_permalinks</span></code> config value can be used to
switch off the generated “paragraph sign” permalinks for each
heading and definition environment.</p></li>
<li><p>The new <code class="docutils literal notranslate"><span class="pre">html_show_sourcelink</span></code> config value can be used to
switch off the links to the reST sources in the sidebar.</p></li>
<li><p>The default value for <code class="docutils literal notranslate"><span class="pre">htmlhelp_basename</span></code> is now the project
title, cleaned up as a filename.</p></li>
<li><p>The new <code class="docutils literal notranslate"><span class="pre">modindex_common_prefix</span></code> config value can be used to
ignore certain package names for module index sorting.</p></li>
<li><p>The new <code class="docutils literal notranslate"><span class="pre">trim_footnote_reference_space</span></code> config value mirrors
the docutils config value of the same name and removes the
space before a footnote reference that is necessary for reST
to recognize the reference.</p></li>
<li><p>The new <code class="docutils literal notranslate"><span class="pre">latex_additional_files</span></code> config value can be used to
copy files (that Sphinx doesn’t copy automatically, e.g. if they
are referenced in custom LaTeX added in <code class="docutils literal notranslate"><span class="pre">latex_elements</span></code>) to
the build directory.</p></li>
</ul>
</li>
<li><p>Builders:</p>
<ul class="simple">
<li><p>The HTML builder now stores a small file named <code class="docutils literal notranslate"><span class="pre">.buildinfo</span></code> in
its output directory. It stores a hash of config values that
can be used to determine if a full rebuild needs to be done (e.g.
after changing <code class="docutils literal notranslate"><span class="pre">html_theme</span></code>).</p></li>
<li><p>New builder for Qt help collections, by Antonio Valentino.</p></li>
<li><p>The new <code class="docutils literal notranslate"><span class="pre">DirectoryHTMLBuilder</span></code> (short name <code class="docutils literal notranslate"><span class="pre">dirhtml</span></code>) creates
a separate directory for every page, and places the page there
in a file called <code class="docutils literal notranslate"><span class="pre">index.html</span></code>. Therefore, page URLs and links
don’t need to contain <code class="docutils literal notranslate"><span class="pre">.html</span></code>.</p></li>
<li><p>The new <code class="docutils literal notranslate"><span class="pre">html_link_suffix</span></code> config value can be used to select
the suffix of generated links between HTML files.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/96">#96</a>: The LaTeX builder now supports figures wrapped by text, when
using the <code class="docutils literal notranslate"><span class="pre">figwidth</span></code> option and right/left alignment.</p></li>
</ul>
</li>
<li><p>New translations:</p>
<ul class="simple">
<li><p>Italian by Sandro Dentella.</p></li>
<li><p>Ukrainian by Petro Sasnyk.</p></li>
<li><p>Finnish by Jukka Inkeri.</p></li>
<li><p>Russian by Alexander Smishlajev.</p></li>
</ul>
</li>
<li><p>Extensions and API:</p>
<ul class="simple">
<li><p>New <code class="docutils literal notranslate"><span class="pre">graphviz</span></code> extension to embed graphviz graphs.</p></li>
<li><p>New <code class="docutils literal notranslate"><span class="pre">inheritance_diagram</span></code> extension to embed… inheritance
diagrams!</p></li>
<li><p>New <code class="docutils literal notranslate"><span class="pre">autosummary</span></code> extension that generates summaries of
modules and automatic documentation of modules.</p></li>
<li><p>Autodoc now has a reusable Python API, which can be used to
create custom types of objects to auto-document (e.g. Zope
interfaces). See also <code class="docutils literal notranslate"><span class="pre">Sphinx.add_autodocumenter()</span></code>.</p></li>
<li><p>Autodoc now handles documented attributes.</p></li>
<li><p>Autodoc now handles inner classes and their methods.</p></li>
<li><p>Autodoc can document classes as functions now if explicitly
marked with <code class="docutils literal notranslate"><span class="pre">autofunction</span></code>.</p></li>
<li><p>Autodoc can now exclude single members from documentation
via the <code class="docutils literal notranslate"><span class="pre">exclude-members</span></code> option.</p></li>
<li><p>Autodoc can now order members either alphabetically (like
previously) or by member type; configurable either with the
config value <code class="docutils literal notranslate"><span class="pre">autodoc_member_order</span></code> or a <code class="docutils literal notranslate"><span class="pre">member-order</span></code>
option per directive.</p></li>
<li><p>The function <code class="docutils literal notranslate"><span class="pre">Sphinx.add_directive()</span></code> now also supports
docutils 0.5-style directive classes. If they inherit from
<code class="docutils literal notranslate"><span class="pre">sphinx.util.compat.Directive</span></code>, they also work with
docutils 0.4.</p></li>
<li><p>There is now a <code class="docutils literal notranslate"><span class="pre">Sphinx.add_lexer()</span></code> method to be able to use
custom Pygments lexers easily.</p></li>
<li><p>There is now <code class="docutils literal notranslate"><span class="pre">Sphinx.add_generic_role()</span></code> to mirror the
docutils’ own function.</p></li>
</ul>
</li>
<li><p>Other changes:</p>
<ul class="simple">
<li><p>Config overrides for single dict keys can now be given on the
command line.</p></li>
<li><p>There is now a <code class="docutils literal notranslate"><span class="pre">doctest_global_setup</span></code> config value that can
be used to give setup code for all doctests in the documentation.</p></li>
<li><p>Source links in HTML are now generated with <code class="docutils literal notranslate"><span class="pre">rel="nofollow"</span></code>.</p></li>
<li><p>Quickstart can now generate a Windows <code class="docutils literal notranslate"><span class="pre">make.bat</span></code> file.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/62">#62</a>: There is now a <code class="docutils literal notranslate"><span class="pre">-w</span></code> option for sphinx-build that writes
warnings to a file, in addition to stderr.</p></li>
<li><p>There is now a <code class="docutils literal notranslate"><span class="pre">-W</span></code> option for sphinx-build that turns warnings
into errors.</p></li>
</ul>
</li>
</ul>
</section>
</section>
<section id="release-0-5-2-mar-24-2009">
<h2>Release 0.5.2 (Mar 24, 2009)<a class="headerlink" href="#release-0-5-2-mar-24-2009" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Properly escape <code class="docutils literal notranslate"><span class="pre">|</span></code> in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/71">#71</a>: If a decoding error occurs in source files, print a
warning and replace the characters by “?”.</p></li>
<li><p>Fix a problem in the HTML search if the index takes too long
to load.</p></li>
<li><p>Don’t output system messages while resolving, because they
would stay in the doctrees even if keep_warnings is false.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/82">#82</a>: Determine the correct path for dependencies noted by
docutils. This fixes behavior where a source with dependent
files was always reported as changed.</p></li>
<li><p>Recognize toctree directives that are not on section toplevel,
but within block items, such as tables.</p></li>
<li><p>Use a new RFC base URL, since rfc.org seems down.</p></li>
<li><p>Fix a crash in the todolist directive when no todo items are
defined.</p></li>
<li><p>Don’t call LaTeX or dvipng over and over again if it was not
found once, and use text-only latex as a substitute in that case.</p></li>
<li><p>Fix problems with footnotes in the LaTeX output.</p></li>
<li><p>Prevent double hyphens becoming en-dashes in literal code in
the LaTeX output.</p></li>
<li><p>Open literalinclude files in universal newline mode to allow
arbitrary newline conventions.</p></li>
<li><p>Actually make the <code class="docutils literal notranslate"><span class="pre">-Q</span></code> option work.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/86">#86</a>: Fix explicit document titles in toctrees.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/81">#81</a>: Write environment and search index in a manner that is safe
from exceptions that occur during dumping.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/80">#80</a>: Fix UnicodeErrors when a locale is set with setlocale().</p></li>
</ul>
</section>
<section id="release-0-5-1-dec-15-2008">
<h2>Release 0.5.1 (Dec 15, 2008)<a class="headerlink" href="#release-0-5-1-dec-15-2008" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/67">#67</a>: Output warnings about failed doctests in the doctest extension
even when running in quiet mode.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/72">#72</a>: In pngmath, make it possible to give a full path to LaTeX and
dvipng on Windows. For that to work, the <code class="docutils literal notranslate"><span class="pre">pngmath_latex</span></code> and
<code class="docutils literal notranslate"><span class="pre">pngmath_dvipng</span></code> options are no longer split into command and
additional arguments; use <code class="docutils literal notranslate"><span class="pre">pngmath_latex_args</span></code> and
<code class="docutils literal notranslate"><span class="pre">pngmath_dvipng_args</span></code> to give additional arguments.</p></li>
<li><p>Don’t crash on failing doctests with non-ASCII characters.</p></li>
<li><p>Don’t crash on writing status messages and warnings containing
unencodable characters.</p></li>
<li><p>Warn if a doctest extension block doesn’t contain any code.</p></li>
<li><p>Fix the handling of <code class="docutils literal notranslate"><span class="pre">:param:</span></code> and <code class="docutils literal notranslate"><span class="pre">:type:</span></code> doc fields when
they contain markup (especially cross-referencing roles).</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/65">#65</a>: Fix storage of depth information for PNGs generated by the
pngmath extension.</p></li>
<li><p>Fix autodoc crash when automethod is used outside a class context.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/68">#68</a>: Fix LaTeX writer output for images with specified height.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/60">#60</a>: Fix wrong generated image path when including images in sources
in subdirectories.</p></li>
<li><p>Fix the JavaScript search when html_copy_source is off.</p></li>
<li><p>Fix an indentation problem in autodoc when documenting classes
with the option <code class="docutils literal notranslate"><span class="pre">autoclass_content</span> <span class="pre">=</span> <span class="pre">"both"</span></code> set.</p></li>
<li><p>Don’t crash on empty index entries, only emit a warning.</p></li>
<li><p>Fix a typo in the search JavaScript code, leading to unusable
search function in some setups.</p></li>
</ul>
</section>
<section id="release-0-5-nov-23-2008-birthday-release">
<h2>Release 0.5 (Nov 23, 2008) – Birthday release!<a class="headerlink" href="#release-0-5-nov-23-2008-birthday-release" title="Link to this heading">¶</a></h2>
<section id="id3182">
<h3>New features added<a class="headerlink" href="#id3182" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Markup features:</p>
<ul>
<li><p>Citations are now global: all citation defined in any file can be
referenced from any file. Citations are collected in a bibliography
for LaTeX output.</p></li>
<li><p>Footnotes are now properly handled in the LaTeX builder: they appear
at the location of the footnote reference in text, not at the end of
a section. Thanks to Andrew McNamara for the initial patch.</p></li>
<li><p>“System Message” warnings are now automatically removed from the
built documentation, and only written to stderr. If you want the
old behavior, set the new config value <code class="docutils literal notranslate"><span class="pre">keep_warnings</span></code> to True.</p></li>
<li><p>Glossary entries are now automatically added to the index.</p></li>
<li><p>Figures with captions can now be referred to like section titles,
using the <code class="docutils literal notranslate"><span class="pre">:ref:</span></code> role without an explicit link text.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">cmember</span></code> role for consistency.</p></li>
<li><p>Lists enumerated by letters or roman numerals are now handled like in
standard reST.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">seealso</span></code> directive can now also be given arguments, as a short
form.</p></li>
<li><p>You can now document several programs and their options with the
new <code class="docutils literal notranslate"><span class="pre">program</span></code> directive.</p></li>
</ul>
</li>
<li><p>HTML output and templates:</p>
<ul>
<li><p>Incompatible change: The “root” relation link (top left in the
relbar) now points to the <code class="docutils literal notranslate"><span class="pre">master_doc</span></code> by default, no longer to a
document called “index”. The old behavior, while useful in some
situations, was somewhat unexpected. Override the “rootrellink”
block in the template to customize where it refers to.</p></li>
<li><p>The JavaScript search now searches for objects before searching in
the full text.</p></li>
<li><p>TOC tree entries now have CSS classes that make it possible to
style them depending on their depth.</p></li>
<li><p>Highlighted code blocks now have CSS classes that make it possible
to style them depending on their language.</p></li>
<li><p>HTML <code class="docutils literal notranslate"><span class="pre"><meta></span></code> tags via the docutils <a class="reference external" href="https://docutils.sourceforge.io/docs/ref/rst/directives.html#meta">meta</a> directive are now
supported.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">SerializingHTMLBuilder</span></code> was added as new abstract builder that
can be subclassed to serialize build HTML in a specific format. The
<code class="docutils literal notranslate"><span class="pre">PickleHTMLBuilder</span></code> is a concrete subclass of it that uses pickle
as serialization implementation.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">JSONHTMLBuilder</span></code> was added as another <code class="docutils literal notranslate"><span class="pre">SerializingHTMLBuilder</span></code>
subclass that dumps the generated HTML into JSON files for further
processing.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">rellinks</span></code> block in the layout template is now called
<code class="docutils literal notranslate"><span class="pre">linktags</span></code> to avoid confusion with the relbar links.</p></li>
<li><p>The HTML builders have two additional attributes now that can be
used to disable the anchor-link creation after headlines and
definition links.</p></li>
<li><p>Only generate a module index if there are some modules in the
documentation.</p></li>
</ul>
</li>
<li><p>New and changed config values:</p>
<ul>
<li><p>Added support for internationalization in generated text with the
<code class="docutils literal notranslate"><span class="pre">language</span></code> and <code class="docutils literal notranslate"><span class="pre">locale_dirs</span></code> config values. Many thanks to
language contributors:</p>
<ul>
<li><p>Horst Gutmann – German</p></li>
<li><p>Pavel Kosina – Czech</p></li>
<li><p>David Larlet – French</p></li>
<li><p>Michał Kandulski – Polish</p></li>
<li><p>Yasushi Masuda – Japanese</p></li>
<li><p>Guillem Borrell – Spanish</p></li>
<li><p>Luc Saffre and Peter Bertels – Dutch</p></li>
<li><p>Fred Lin – Traditional Chinese</p></li>
<li><p>Roger Demetrescu – Brazilian Portuguese</p></li>
<li><p>Rok Garbas – Slovenian</p></li>
</ul>
</li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">highlight_language</span></code> set a global default for
highlighting. When <code class="docutils literal notranslate"><span class="pre">'python3'</span></code> is selected, console output blocks
are recognized like for <code class="docutils literal notranslate"><span class="pre">'python'</span></code>.</p></li>
<li><p>Exposed Pygments’ lexer guessing as a highlight “language” <code class="docutils literal notranslate"><span class="pre">guess</span></code>.</p></li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">latex_elements</span></code> allows to override all LaTeX
snippets that Sphinx puts into the generated .tex file by default.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">exclude_dirnames</span></code> config value that can be used to exclude
e.g. CVS directories from source file search.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">source_encoding</span></code> config value to select input encoding.</p></li>
</ul>
</li>
<li><p>Extensions:</p>
<ul>
<li><p>The new extensions <code class="docutils literal notranslate"><span class="pre">sphinx.ext.jsmath</span></code> and <code class="docutils literal notranslate"><span class="pre">sphinx.ext.pngmath</span></code>
provide math support for both HTML and LaTeX builders.</p></li>
<li><p>The new extension <code class="docutils literal notranslate"><span class="pre">sphinx.ext.intersphinx</span></code> half-automatically
creates links to Sphinx documentation of Python objects in other
projects.</p></li>
<li><p>The new extension <code class="docutils literal notranslate"><span class="pre">sphinx.ext.todo</span></code> allows the insertion of
“To do” directives whose visibility in the output can be toggled.
It also adds a directive to compile a list of all todo items.</p></li>
<li><p>sphinx.ext.autodoc has a new event <code class="docutils literal notranslate"><span class="pre">autodoc-process-signature</span></code>
that allows tuning function signature introspection.</p></li>
<li><p>sphinx.ext.autodoc has a new event <code class="docutils literal notranslate"><span class="pre">autodoc-skip-member</span></code> that allows
tuning which members are included in the generated content.</p></li>
<li><p>Respect __all__ when autodocumenting module members.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">automodule</span></code> directive now supports the <code class="docutils literal notranslate"><span class="pre">synopsis</span></code>,
<code class="docutils literal notranslate"><span class="pre">deprecated</span></code> and <code class="docutils literal notranslate"><span class="pre">platform</span></code> options.</p></li>
</ul>
</li>
<li><p>Extension API:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">Sphinx.add_node()</span></code> now takes optional visitor methods for the
HTML, LaTeX and text translators; this prevents having to manually
patch the classes.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">Sphinx.add_javascript()</span></code> that adds scripts to load in the
default HTML template.</p></li>
<li><p>Added new events: <code class="docutils literal notranslate"><span class="pre">source-read</span></code>, <code class="docutils literal notranslate"><span class="pre">env-updated</span></code>,
<code class="docutils literal notranslate"><span class="pre">env-purge-doc</span></code>, <code class="docutils literal notranslate"><span class="pre">missing-reference</span></code>, <code class="docutils literal notranslate"><span class="pre">build-finished</span></code>.</p></li>
</ul>
</li>
<li><p>Other changes:</p>
<ul>
<li><p>Added a command-line switch <code class="docutils literal notranslate"><span class="pre">-Q</span></code>: it will suppress warnings.</p></li>
<li><p>Added a command-line switch <code class="docutils literal notranslate"><span class="pre">-A</span></code>: it can be used to supply
additional values into the HTML templates.</p></li>
<li><p>Added a command-line switch <code class="docutils literal notranslate"><span class="pre">-C</span></code>: if it is given, no configuration
file <code class="docutils literal notranslate"><span class="pre">conf.py</span></code> is required.</p></li>
<li><p>Added a distutils command <code class="docutils literal notranslate"><span class="pre">build_sphinx</span></code>: When Sphinx is installed,
you can call <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">build_sphinx</span></code> for projects that have
Sphinx documentation, which will build the docs and place them in
the standard distutils build directory.</p></li>
<li><p>In quickstart, if the selected root path already contains a Sphinx
project, complain and abort.</p></li>
</ul>
</li>
</ul>
</section>
<section id="id3183">
<h3>Bugs fixed<a class="headerlink" href="#id3183" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/51">#51</a>: Escape configuration values placed in HTML templates.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/44">#44</a>: Fix small problems in HTML help index generation.</p></li>
<li><p>Fix LaTeX output for line blocks in tables.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/38">#38</a>: Fix “illegal unit” error when using pixel image widths/heights.</p></li>
<li><p>Support table captions in LaTeX output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/39">#39</a>: Work around a bug in Jinja that caused “<generator …>” to be
emitted in HTML output.</p></li>
<li><p>Fix a problem with module links not being generated in LaTeX output.</p></li>
<li><p>Fix the handling of images in different directories.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/29">#29</a>: Support option lists in the text writer. Make sure that dashes
introducing long option names are not contracted to en-dashes.</p></li>
<li><p>Support the “scale” option for images in HTML output.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/25">#25</a>: Properly escape quotes in HTML help attribute values.</p></li>
<li><p>Fix LaTeX build for some description environments with <code class="docutils literal notranslate"><span class="pre">:noindex:</span></code>.</p></li>
<li><p><a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues/24">#24</a>: Don’t crash on uncommon casing of role names (like <code class="docutils literal notranslate"><span class="pre">:Class:</span></code>).</p></li>
<li><p>Only output ANSI colors on color terminals.</p></li>
<li><p>Update to newest fncychap.sty, to fix problems with non-ASCII
characters at the start of chapter titles.</p></li>
<li><p>Fix a problem with index generation in LaTeX output, caused by
hyperref not being included last.</p></li>
<li><p>Don’t disregard return annotations for functions without any parameters.</p></li>
<li><p>Don’t throw away labels for code blocks.</p></li>
</ul>
</section>
</section>
<section id="release-0-4-3-oct-8-2008">
<h2>Release 0.4.3 (Oct 8, 2008)<a class="headerlink" href="#release-0-4-3-oct-8-2008" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Fix a bug in autodoc with directly given autodoc members.</p></li>
<li><p>Fix a bug in autodoc that would import a module twice, once as
“module”, once as “module.”.</p></li>
<li><p>Fix a bug in the HTML writer that created duplicate <code class="docutils literal notranslate"><span class="pre">id</span></code>
attributes for section titles with docutils 0.5.</p></li>
<li><p>Properly call <code class="docutils literal notranslate"><span class="pre">super()</span></code> in overridden blocks in templates.</p></li>
<li><p>Add a fix when using XeTeX.</p></li>
<li><p>Unify handling of LaTeX escaping.</p></li>
<li><p>Rebuild everything when the <code class="docutils literal notranslate"><span class="pre">extensions</span></code> config value changes.</p></li>
<li><p>Don’t try to remove a nonexisting static directory.</p></li>
<li><p>Fix an indentation problem in production lists.</p></li>
<li><p>Fix encoding handling for literal include files: <code class="docutils literal notranslate"><span class="pre">literalinclude</span></code>
now has an <code class="docutils literal notranslate"><span class="pre">encoding</span></code> option that defaults to UTF-8.</p></li>
<li><p>Fix the handling of non-ASCII characters entered in quickstart.</p></li>
<li><p>Fix a crash with nonexisting image URIs.</p></li>
</ul>
</section>
<section id="release-0-4-2-jul-29-2008">
<h2>Release 0.4.2 (Jul 29, 2008)<a class="headerlink" href="#release-0-4-2-jul-29-2008" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Fix rendering of the <code class="docutils literal notranslate"><span class="pre">samp</span></code> role in HTML.</p></li>
<li><p>Fix a bug with LaTeX links to headings leading to a wrong page.</p></li>
<li><p>Reread documents with globbed toctrees when source files are
added or removed.</p></li>
<li><p>Add a missing parameter to PickleHTMLBuilder.handle_page().</p></li>
<li><p>Put inheritance info always on its own line.</p></li>
<li><p>Don’t automatically enclose code with whitespace in it in quotes;
only do this for the <code class="docutils literal notranslate"><span class="pre">samp</span></code> role.</p></li>
<li><p>autodoc now emits a more precise error message when a module
can’t be imported or an attribute can’t be found.</p></li>
<li><p>The JavaScript search now uses the correct file name suffix when
referring to found items.</p></li>
<li><p>The automodule directive now accepts the <code class="docutils literal notranslate"><span class="pre">inherited-members</span></code>
and <code class="docutils literal notranslate"><span class="pre">show-inheritance</span></code> options again.</p></li>
<li><p>You can now rebuild the docs normally after relocating the source
and/or doctree directory.</p></li>
</ul>
</section>
<section id="release-0-4-1-jul-5-2008">
<h2>Release 0.4.1 (Jul 5, 2008)<a class="headerlink" href="#release-0-4-1-jul-5-2008" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Added sub-/superscript node handling to TextBuilder.</p></li>
<li><p>Label names in references are now case-insensitive, since reST
label names are always lowercased.</p></li>
<li><p>Fix linkcheck builder crash for malformed URLs.</p></li>
<li><p>Add compatibility for admonitions and docutils 0.5.</p></li>
<li><p>Remove the silly restriction on “rubric” in the LaTeX writer: you
can now write arbitrary “rubric” directives, and only those with
a title of “Footnotes” will be ignored.</p></li>
<li><p>Copy the HTML logo to the output <code class="docutils literal notranslate"><span class="pre">_static</span></code> directory.</p></li>
<li><p>Fix LaTeX code for modules with underscores in names and platforms.</p></li>
<li><p>Fix a crash with nonlocal image URIs.</p></li>
<li><p>Allow the usage of :noindex: in <code class="docutils literal notranslate"><span class="pre">automodule</span></code> directives, as
documented.</p></li>
<li><p>Fix the <code class="docutils literal notranslate"><span class="pre">delete()</span></code> docstring processor function in autodoc.</p></li>
<li><p>Fix warning message for nonexisting images.</p></li>
<li><p>Fix JavaScript search in Internet Explorer.</p></li>
</ul>
</section>
<section id="release-0-4-jun-23-2008">
<h2>Release 0.4 (Jun 23, 2008)<a class="headerlink" href="#release-0-4-jun-23-2008" title="Link to this heading">¶</a></h2>
<section id="id3191">
<h3>New features added<a class="headerlink" href="#id3191" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">tocdepth</span></code> can be given as a file-wide metadata entry, and
specifies the maximum depth of a TOC of this file.</p></li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">default_role</span></code> can be used to select the
default role for all documents.</p></li>
<li><p>Sphinx now interprets field lists with fields like <code class="docutils literal notranslate"><span class="pre">:param</span> <span class="pre">foo:</span></code>
in description units.</p></li>
<li><p>The new <code class="docutils literal notranslate"><span class="pre">staticmethod</span></code> directive can be used to mark methods as
static methods.</p></li>
<li><p>HTML output:</p>
<ul>
<li><p>The “previous” and “next” links have a more logical structure, so
that by following “next” links you can traverse the entire TOC
tree.</p></li>
<li><p>The new event <code class="docutils literal notranslate"><span class="pre">html-page-context</span></code> can be used to include custom
values into the context used when rendering an HTML template.</p></li>
<li><p>Document metadata is now in the default template context, under
the name <code class="docutils literal notranslate"><span class="pre">metadata</span></code>.</p></li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">html_favicon</span></code> can be used to set a favicon
for the HTML output. Thanks to Sebastian Wiesner.</p></li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">html_use_index</span></code> can be used to switch index
generation in HTML documents off.</p></li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">html_split_index</span></code> can be used to create
separate index pages for each letter, to be used when the complete
index is too large for one page.</p></li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">html_short_title</span></code> can be used to set a
shorter title for the documentation which is then used in the
navigation bar.</p></li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">html_show_sphinx</span></code> can be used to control
whether a link to Sphinx is added to the HTML footer.</p></li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">html_file_suffix</span></code> can be used to set the
HTML file suffix to e.g. <code class="docutils literal notranslate"><span class="pre">.xhtml</span></code>.</p></li>
<li><p>The directories in the <code class="docutils literal notranslate"><span class="pre">html_static_path</span></code> can now contain
subdirectories.</p></li>
<li><p>The module index now isn’t collapsed if the number of submodules
is larger than the number of toplevel modules.</p></li>
</ul>
</li>
<li><p>The image directive now supports specifying the extension as <code class="docutils literal notranslate"><span class="pre">.*</span></code>,
which makes the builder select the one that matches best. Thanks to
Sebastian Wiesner.</p></li>
<li><p>The new config value <code class="docutils literal notranslate"><span class="pre">exclude_trees</span></code> can be used to exclude whole
subtrees from the search for source files.</p></li>
<li><p>Defaults for configuration values can now be callables, which allows
dynamic defaults.</p></li>
<li><p>The new TextBuilder creates plain-text output.</p></li>
<li><p>Python 3-style signatures, giving a return annotation via <code class="docutils literal notranslate"><span class="pre">-></span></code>,
are now supported.</p></li>
<li><p>Extensions:</p>
<ul>
<li><p>The autodoc extension now offers a much more flexible way to
manipulate docstrings before including them into the output, via
the new <code class="docutils literal notranslate"><span class="pre">autodoc-process-docstring</span></code> event.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">autodoc</span></code> extension accepts signatures for functions, methods
and classes now that override the signature got via introspection
from Python code.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">autodoc</span></code> extension now offers a <code class="docutils literal notranslate"><span class="pre">show-inheritance</span></code> option
for autoclass that inserts a list of bases after the signature.</p></li>
<li><p>The autodoc directives now support the <code class="docutils literal notranslate"><span class="pre">noindex</span></code> flag option.</p></li>
</ul>
</li>
</ul>
</section>
<section id="id3192">
<h3>Bugs fixed<a class="headerlink" href="#id3192" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Correctly report the source location for docstrings included with
autodoc.</p></li>
<li><p>Fix the LaTeX output of description units with multiple signatures.</p></li>
<li><p>Handle the figure directive in LaTeX output.</p></li>
<li><p>Handle raw admonitions in LaTeX output.</p></li>
<li><p>Fix determination of the title in HTML help output.</p></li>
<li><p>Handle project names containing spaces.</p></li>
<li><p>Don’t write SSI-like comments in HTML output.</p></li>
<li><p>Rename the “sidebar” class to “sphinxsidebar” in order to stay different
from reST sidebars.</p></li>
<li><p>Use a binary TOC in HTML help generation to fix issues links without
explicit anchors.</p></li>
<li><p>Fix behavior of references to functions/methods with an explicit title.</p></li>
<li><p>Support citation, subscript and superscript nodes in LaTeX writer.</p></li>
<li><p>Provide the standard “class” directive as “cssclass”; else it is
shadowed by the Sphinx-defined directive.</p></li>
<li><p>Fix the handling of explicit module names given to autoclass directives.
They now show up with the correct module name in the generated docs.</p></li>
<li><p>Enable autodoc to process Unicode docstrings.</p></li>
<li><p>The LaTeX writer now translates line blocks with <code class="docutils literal notranslate"><span class="pre">\raggedright</span></code>,
which plays nicer with tables.</p></li>
<li><p>Fix bug with directories in the HTML builder static path.</p></li>
</ul>
</section>
</section>
<section id="release-0-3-may-6-2008">
<h2>Release 0.3 (May 6, 2008)<a class="headerlink" href="#release-0-3-may-6-2008" title="Link to this heading">¶</a></h2>
<section id="id3193">
<h3>New features added<a class="headerlink" href="#id3193" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>The <code class="docutils literal notranslate"><span class="pre">toctree</span></code> directive now supports a <code class="docutils literal notranslate"><span class="pre">glob</span></code> option that allows
glob-style entries in the content.</p></li>
<li><p>If the <code class="docutils literal notranslate"><span class="pre">pygments_style</span></code> config value contains a dot it’s treated as the
import path of a custom Pygments style class.</p></li>
<li><p>A new config value, <code class="docutils literal notranslate"><span class="pre">exclude_dirs</span></code>, can be used to exclude whole
directories from the search for source files.</p></li>
<li><p>The configuration directory (containing <code class="docutils literal notranslate"><span class="pre">conf.py</span></code>) can now be set
independently from the source directory. For that, a new command-line
option <code class="docutils literal notranslate"><span class="pre">-c</span></code> has been added.</p></li>
<li><p>A new directive <code class="docutils literal notranslate"><span class="pre">tabularcolumns</span></code> can be used to give a tabular column
specification for LaTeX output. Tables now use the <code class="docutils literal notranslate"><span class="pre">tabulary</span></code> package.
Literal blocks can now be placed in tables, with several caveats.</p></li>
<li><p>A new config value, <code class="docutils literal notranslate"><span class="pre">latex_use_parts</span></code>, can be used to enable parts in LaTeX
documents.</p></li>
<li><p>Autodoc now skips inherited members for classes, unless you give the
new <code class="docutils literal notranslate"><span class="pre">inherited-members</span></code> option.</p></li>
<li><p>A new config value, <code class="docutils literal notranslate"><span class="pre">autoclass_content</span></code>, selects if the docstring of the
class’ <code class="docutils literal notranslate"><span class="pre">__init__</span></code> method is added to the directive’s body.</p></li>
<li><p>Support for C++ class names (in the style <code class="docutils literal notranslate"><span class="pre">Class::Function</span></code>) in C function
descriptions.</p></li>
<li><p>Support for a <code class="docutils literal notranslate"><span class="pre">toctree_only</span></code> item in items for the <code class="docutils literal notranslate"><span class="pre">latex_documents</span></code>
config value. This only includes the documents referenced by TOC trees in the
output, not the rest of the file containing the directive.</p></li>
</ul>
</section>
<section id="id3194">
<h3>Bugs fixed<a class="headerlink" href="#id3194" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>sphinx.htmlwriter: Correctly write the TOC file for any structure of the
master document. Also encode non-ASCII characters as entities in TOC
and index file. Remove two remaining instances of hard-coded
“documentation”.</p></li>
<li><p>sphinx.ext.autodoc: descriptors are detected properly now.</p></li>
<li><p>sphinx.latexwriter: implement all reST admonitions, not just <code class="docutils literal notranslate"><span class="pre">note</span></code>
and <code class="docutils literal notranslate"><span class="pre">warning</span></code>.</p></li>
<li><p>Lots of little fixes to the LaTeX output and style.</p></li>
<li><p>Fix OpenSearch template and make template URL absolute. The
<code class="docutils literal notranslate"><span class="pre">html_use_opensearch</span></code> config value now must give the base URL.</p></li>
<li><p>Some unused files are now stripped from the HTML help file build.</p></li>
</ul>
</section>
</section>
<section id="release-0-2-apr-27-2008">
<h2>Release 0.2 (Apr 27, 2008)<a class="headerlink" href="#release-0-2-apr-27-2008" title="Link to this heading">¶</a></h2>
<section id="id3195">
<h3>Incompatible changes<a class="headerlink" href="#id3195" title="Link to this heading">¶</a></h3>
<ul>
<li><p>Jinja, the template engine used for the default HTML templates, is now
no longer shipped with Sphinx. If it is not installed automatically for
you (it is now listed as a dependency in <code class="docutils literal notranslate"><span class="pre">setup.py</span></code>), install it manually
from PyPI. This will also be needed if you’re using Sphinx from a SVN
checkout; in that case please also remove the <code class="docutils literal notranslate"><span class="pre">sphinx/jinja</span></code> directory
that may be left over from old revisions.</p></li>
<li><p>The clumsy handling of the <code class="docutils literal notranslate"><span class="pre">index.html</span></code> template was removed. The config
value <code class="docutils literal notranslate"><span class="pre">html_index</span></code> is gone, and <code class="docutils literal notranslate"><span class="pre">html_additional_pages</span></code> should be used
instead. If you need it, the old <code class="docutils literal notranslate"><span class="pre">index.html</span></code> template is still there,
called <code class="docutils literal notranslate"><span class="pre">defindex.html</span></code>, and you can port your html_index template, using
Jinja inheritance, by changing your template:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="o">%</span> <span class="n">extends</span> <span class="s2">"defindex.html"</span> <span class="o">%</span><span class="p">}</span>
<span class="p">{</span><span class="o">%</span> <span class="n">block</span> <span class="n">tables</span> <span class="o">%</span><span class="p">}</span>
<span class="o">...</span> <span class="n">old</span> <span class="n">html_index</span> <span class="n">template</span> <span class="n">content</span> <span class="o">...</span>
<span class="p">{</span><span class="o">%</span> <span class="n">endblock</span> <span class="o">%</span><span class="p">}</span>
</pre></div>
</div>
<p>and putting <code class="docutils literal notranslate"><span class="pre">'index':</span> <span class="pre">name</span> <span class="pre">of</span> <span class="pre">your</span> <span class="pre">template</span></code> in <code class="docutils literal notranslate"><span class="pre">html_additional_pages</span></code>.</p>
</li>
<li><p>In the layout template, redundant <code class="docutils literal notranslate"><span class="pre">block</span></code>s were removed; you should use
Jinja’s standard <code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">super()</span> <span class="pre">}}</span></code> mechanism instead, as explained in the
(newly written) templating docs.</p></li>
</ul>
</section>
<section id="id3196">
<h3>New features added<a class="headerlink" href="#id3196" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>Extension API (Application object):</p>
<ul>
<li><p>Support a new method, <code class="docutils literal notranslate"><span class="pre">add_crossref_type</span></code>. It works like
<code class="docutils literal notranslate"><span class="pre">add_description_unit</span></code> but the directive will only create a target
and no output.</p></li>
<li><p>Support a new method, <code class="docutils literal notranslate"><span class="pre">add_transform</span></code>. It takes a standard docutils
<code class="docutils literal notranslate"><span class="pre">Transform</span></code> subclass which is then applied by Sphinx’ reader on
parsing reST document trees.</p></li>
<li><p>Add support for other template engines than Jinja, by adding an
abstraction called a “template bridge”. This class handles rendering
of templates and can be changed using the new configuration value
“template_bridge”.</p></li>
<li><p>The config file itself can be an extension (if it provides a <code class="docutils literal notranslate"><span class="pre">setup()</span></code>
function).</p></li>
</ul>
</li>
<li><p>Markup:</p>
<ul>
<li><p>New directive, <code class="docutils literal notranslate"><span class="pre">currentmodule</span></code>. It can be used to indicate the module
name of the following documented things without creating index entries.</p></li>
<li><p>Allow giving a different title to documents in the toctree.</p></li>
<li><p>Allow giving multiple options in a <code class="docutils literal notranslate"><span class="pre">cmdoption</span></code> directive.</p></li>
<li><p>Fix display of class members without explicit class name given.</p></li>
</ul>
</li>
<li><p>Templates (HTML output):</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">index.html</span></code> renamed to <code class="docutils literal notranslate"><span class="pre">defindex.html</span></code>, see above.</p></li>
<li><p>There’s a new config value, <code class="docutils literal notranslate"><span class="pre">html_title</span></code>, that controls the overall
“title” of the set of Sphinx docs. It is used instead everywhere instead of
“Projectname vX.Y documentation” now.</p></li>
<li><p>All references to “documentation” in the templates have been removed, so
that it is now easier to use Sphinx for non-documentation documents with
the default templates.</p></li>
<li><p>Templates now have an XHTML doctype, to be consistent with docutils’
HTML output.</p></li>
<li><p>You can now create an OpenSearch description file with the
<code class="docutils literal notranslate"><span class="pre">html_use_opensearch</span></code> config value.</p></li>
<li><p>You can now quickly include a logo in the sidebar, using the <code class="docutils literal notranslate"><span class="pre">html_logo</span></code>
config value.</p></li>
<li><p>There are new blocks in the sidebar, so that you can easily insert content
into the sidebar.</p></li>
</ul>
</li>
<li><p>LaTeX output:</p>
<ul>
<li><p>The <code class="docutils literal notranslate"><span class="pre">sphinx.sty</span></code> package was cleaned of unused stuff.</p></li>
<li><p>You can include a logo in the title page with the <code class="docutils literal notranslate"><span class="pre">latex_logo</span></code> config
value.</p></li>
<li><p>You can define the link colors and a border and background color for
verbatim environments.</p></li>
</ul>
</li>
</ul>
<p>Thanks to Jacob Kaplan-Moss, Talin, Jeroen Ruigrok van der Werven and Sebastian
Wiesner for suggestions.</p>
</section>
<section id="id3197">
<h3>Bugs fixed<a class="headerlink" href="#id3197" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p>sphinx.ext.autodoc: Don’t check <code class="docutils literal notranslate"><span class="pre">__module__</span></code> for explicitly given
members. Remove “self” in class constructor argument list.</p></li>
<li><p>sphinx.htmlwriter: Don’t use os.path for joining image HREFs.</p></li>
<li><p>sphinx.htmlwriter: Don’t use SmartyPants for HTML attribute values.</p></li>
<li><p>sphinx.latexwriter: Implement option lists. Also, some other changes
were made to <code class="docutils literal notranslate"><span class="pre">sphinx.sty</span></code> in order to enhance compatibility and
remove old unused stuff. Thanks to Gael Varoquaux for that!</p></li>
<li><p>sphinx.roles: Fix referencing glossary terms with explicit targets.</p></li>
<li><p>sphinx.environment: Don’t swallow TOC entries when resolving subtrees.</p></li>
<li><p>sphinx.quickstart: Create a sensible default latex_documents setting.</p></li>
<li><p>sphinx.builder, sphinx.environment: Gracefully handle some user error
cases.</p></li>
<li><p>sphinx.util: Follow symbolic links when searching for documents.</p></li>
</ul>
</section>
</section>
<section id="release-0-1-61950-mar-26-2008">
<h2>Release 0.1.61950 (Mar 26, 2008)<a class="headerlink" href="#release-0-1-61950-mar-26-2008" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>sphinx.quickstart: Fix format string for Makefile.</p></li>
</ul>
</section>
<section id="release-0-1-61945-mar-26-2008">
<h2>Release 0.1.61945 (Mar 26, 2008)<a class="headerlink" href="#release-0-1-61945-mar-26-2008" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>sphinx.htmlwriter, sphinx.latexwriter: Support the <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">image::</span></code>
directive by copying image files to the output directory.</p></li>
<li><p>sphinx.builder: Consistently name “special” HTML output directories
with a leading underscore; this means <code class="docutils literal notranslate"><span class="pre">_sources</span></code> and <code class="docutils literal notranslate"><span class="pre">_static</span></code>.</p></li>
<li><p>sphinx.environment: Take dependent files into account when collecting
the set of outdated sources.</p></li>
<li><p>sphinx.directives: Record files included with <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">literalinclude::</span></code>
as dependencies.</p></li>
<li><p>sphinx.ext.autodoc: Record files from which docstrings are included
as dependencies.</p></li>
<li><p>sphinx.builder: Rebuild all HTML files in case of a template change.</p></li>
<li><p>sphinx.builder: Handle unavailability of TOC relations (previous/
next chapter) more gracefully in the HTML builder.</p></li>
<li><p>sphinx.latexwriter: Include fncychap.sty which doesn’t seem to be
very common in TeX distributions. Add a <code class="docutils literal notranslate"><span class="pre">clean</span></code> target in the
latex Makefile. Really pass the correct paper and size options
to the LaTeX document class.</p></li>
<li><p>setup: On Python 2.4, don’t egg-depend on docutils if a docutils is
already installed – else it will be overwritten.</p></li>
</ul>
</section>
<section id="release-0-1-61843-mar-24-2008">
<h2>Release 0.1.61843 (Mar 24, 2008)<a class="headerlink" href="#release-0-1-61843-mar-24-2008" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>sphinx.quickstart: Really don’t create a makefile if the user
doesn’t want one.</p></li>
<li><p>setup: Don’t install scripts twice, via setuptools entry points
and distutils scripts. Only install via entry points.</p></li>
<li><p>sphinx.builder: Don’t recognize the HTML builder’s copied source
files (under <code class="docutils literal notranslate"><span class="pre">_sources</span></code>) as input files if the source suffix is
<code class="docutils literal notranslate"><span class="pre">.txt</span></code>.</p></li>
<li><p>sphinx.highlighting: Generate correct markup for LaTeX Verbatim
environment escapes even if Pygments is not installed.</p></li>
<li><p>sphinx.builder: The WebHTMLBuilder is now called PickleHTMLBuilder.</p></li>
<li><p>sphinx.htmlwriter: Make parsed-literal blocks work as expected,
not highlighting them via Pygments.</p></li>
<li><p>sphinx.environment: Don’t error out on reading an empty source file.</p></li>
</ul>
</section>
<section id="release-0-1-61798-mar-23-2008">
<h2>Release 0.1.61798 (Mar 23, 2008)<a class="headerlink" href="#release-0-1-61798-mar-23-2008" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>sphinx: Work with docutils SVN snapshots as well as 0.4.</p></li>
<li><p>sphinx.ext.doctest: Make the group in which doctest blocks are
placed selectable, and default to <code class="docutils literal notranslate"><span class="pre">'default'</span></code>.</p></li>
<li><p>sphinx.ext.doctest: Replace <code class="docutils literal notranslate"><span class="pre"><BLANKLINE></span></code> in doctest blocks by
real blank lines for presentation output, and remove doctest
options given inline.</p></li>
<li><p>sphinx.environment: Move doctest_blocks out of block_quotes to
support indented doctest blocks.</p></li>
<li><p>sphinx.ext.autodoc: Render <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">automodule::</span></code> docstrings in a
section node, so that module docstrings can contain proper
sectioning.</p></li>
<li><p>sphinx.ext.autodoc: Use the module’s encoding for decoding
docstrings, rather than requiring ASCII.</p></li>
</ul>
</section>
<section id="release-0-1-61611-mar-21-2008">
<h2>Release 0.1.61611 (Mar 21, 2008)<a class="headerlink" href="#release-0-1-61611-mar-21-2008" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>First public release.</p></li>
</ul>
</section>
</section>
</div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2007-2024, the Sphinx developers.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>