Sphinx

* 2707: (latex) the column width is badly computed for tabular
* 2799: Sphinx installs roles and directives automatically on importing sphinx
module. Now Sphinx installs them on running application.
* ``sphinx.ext.autodoc`` crashes if target code imports * from mock modules
by ``autodoc_mock_imports``.
* 1953: ``Sphinx.add_node`` does not add handlers the translator installed by
``html_translator_class``
* 1797: text builder inserts blank line on top
* 2894: quickstart main() doesn't use argv argument
* 2874: gettext builder could not extract all text under the ``only``
directives
* 2485: autosummary crashes with multiple source_suffix values
* 1734: Could not translate the caption of toctree directive
* Could not translate the content of meta directive (ref: 1734)
* 2550: external links are opened in help viewer
* 2687: Running Sphinx multiple times produces 'already registered' warnings

=====================================

Bugs fixed
----------

* 2936: Fix doc/Makefile that can't build man because doc/man exists
* 3058: Using the same 'caption' attribute in multiple 'toctree' directives
results in warning / error
* 3068: Allow the '=' character in the -D option of sphinx-build.py
* 3074: ``add_source_parser()`` crashes in debug mode
* 3135: ``sphinx.ext.autodoc`` crashes with plain Callable
* 3150: Fix query word splitter in JavaScript. It behaves as same as Python's
regular expression.
* 3093: gettext build broken on substituted images.
* 3093: gettext build broken on image node under ``note`` directive.
* imgmath: crashes on showing error messages if image generation failed
* 3117: LaTeX writer crashes if admonition is placed before first section title
* 3164: Change search order of ``sphinx.ext.inheritance_diagram``

====================================

Bugs fixed
----------

* 2996: The wheel package of Sphinx got crash with ImportError

====================================

Bugs fixed
----------

* 2890: Quickstart should return an error consistently on all error conditions
* 2870: flatten genindex columns' heights.
* 2856: Search on generated HTML site doesn't find some symbols
* 2882: Fall back to a GET request on 403 status in linkcheck
* 2902: jsdump.loads fails to load search index if keywords starts with
underscore
* 2900: Fix epub content.opf: add auto generated orphan files to spine.
* 2899: Fix ``hasdoc()`` function in Jinja2 template. It will detect
``genindex``, ``search`` also.
* 2901: Fix epub result: skip creating links from image tags to original image
files.
* 2917: inline code is hyphenated on HTML
* 1462: autosummary warns for namedtuple with attribute with trailing
underscore
* Could not reference equations if ``:nowrap:`` option specified
* 2873: code-block overflow in latex (due to commas)
* 1060, 2056: sphinx.ext.intersphinx: broken links are generated if relative
paths are used in ``intersphinx_mapping``
* 2931: code-block directive with same :caption: causes warning of duplicate
target. Now ``code-block`` and ``literalinclude`` does not define hyperlink
target using its caption automatically.
* 2962: latex: missing label of longtable
* 2968: autodoc: show-inheritance option breaks docstrings

=====================================

Incompatible changes
--------------------

* 2867: linkcheck builder crashes with six-1.4. Now Sphinx depends on six-1.5
or later

Bugs fixed
----------

* applehelp: Sphinx crashes if ``hiutil`` or ``codesign`` commands not found
* Fix ``make clean`` abort issue when build dir contains regular files like
``DS_Store``.
* Reduce epubcheck warnings/errors:

* Fix DOCTYPE to html5
* Change extension from .html to .xhtml.
* Disable search page on epub results

* 2778: Fix autodoc crashes if obj.__dict__ is a property method and raises
exception
* Fix duplicated toc in epub3 output.
* 2775: Fix failing linkcheck with servers not supporting identity encoding
* 2833: Fix formatting instance annotations in ext.autodoc.
* 1911: ``-D`` option of ``sphinx-build`` does not override the ``extensions``
variable
* 2789: ``sphinx.ext.intersphinx`` generates wrong hyperlinks if the inventory is
given
* parsing errors for caption of code-blocks are displayed in document
(ref: 2845)
* 2846: ``singlehtml`` builder does not include figure numbers
* 2816: Fix data from builds cluttering the ``Domain.initial_data`` class
attributes

=====================================

Incompatible changes
--------------------

* 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: 2672)
* latex, use of ``\includegraphics`` to refer to Sphinx custom variant is
deprecated; in future it will revert to original LaTeX macro, custom one
already has alternative name ``\sphinxincludegraphics``.

Features added
--------------

* new config option :confval:`!latex_keep_old_macro_names`, defaults to ``True``.
If ``False``, lets macros (for text styling) be defined
only with ``\sphinx``-prefixed names
* latex writer allows user customization of "shadowed" boxes (topics), via
three length variables.
* woff-format web font files now supported by the epub builder.

Bugs fixed
----------

* jsdump fix for python 3: fixes the HTML search on python > 3
* 2676: (latex) Error with verbatim text in captions since Sphinx 1.4.4
* 2629: memoir class crashes LaTeX. Fixed by
``latex_keep_old_macro_names=False`` (ref 2675)
* 2684: ``sphinx.ext.intersphinx`` crashes with six-1.4.1
* 2679: ``float`` package needed for ``'figure_align': 'H'`` latex option
* 2671: image directive may lead to inconsistent spacing in pdf
* 2705: ``toctree`` generates empty bullet_list if ``:titlesonly:`` specified
* 2479: ``sphinx.ext.viewcode`` uses python2 highlighter by default
* 2700: HtmlHelp builder has hard coded index.html
* latex, since 1.4.4 inline literal text is followed by spurious space
* 2722: C++, fix id generation for var/member declarations to include
namespaces.
* latex, images (from image directive) in lists or quoted blocks did not obey
indentation (fixed together with 2671)
* 2733: since Sphinx 1.4.4 ``make latexpdf`` generates lots of hyperref
warnings
* 2731: ``sphinx.ext.autodoc`` does not access propertymethods which raises any
exceptions
* 2666: C++, properly look up nested names involving constructors.
* 2579: Could not refer a label including both spaces and colons via
``sphinx.ext.intersphinx``
* 2718: Sphinx crashes if the document file is not readable
* 2699: hyperlinks in help HTMLs are broken if ``html_file_suffix`` is set
* 2723: extra spaces in latex pdf output from multirow cell
* 2735: latexpdf ``Underfull \hbox (badness 10000)`` warnings from title page
* 2667: latex crashes if resized images appeared in section title
* 2763: (html) Provide default value for required ``alt`` attribute for image
tags of SVG source, required to validate and now consistent w/ other formats.