Sphinx

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

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

* Fix line numbers was not shown on warnings in LaTeX and texinfo builders
* Fix filenames were not shown on warnings of citations
* Fix line numbers was not shown on warnings in LaTeX and texinfo builders
* Fix line numbers was not shown on warnings of indices
* 2026: Fix LaTeX builder raises error if parsed-literal includes links
* 2243: Ignore strange docstring types for classes, do not crash
* 2247: Fix 2205 breaks make html for definition list with classifiers
that contains regular-expression like string
* 1565: Sphinx will now emit a warning that highlighting was skipped if the
syntax is incorrect for ``code-block``, ``literalinclude`` and so on.
* 2211: Fix paragraphs in table cell doesn't work in Latex output
* 2253: ``:pyobject:`` option of ``literalinclude`` directive can't detect
indented body block when the block starts with blank or comment lines.
* Fix TOC is not shown when no ``:maxdepth:`` for toctrees (ref: 771)
* Fix warning message for ``:numref:`` if target is in orphaned doc (ref: 2244)

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

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

* 2134: Fix figure caption with reference causes latex build error
* 2094: Fix rubric with reference not working in Latex
* 2147: Fix literalinclude code in latex does not break in pages
* 1833: Fix email addresses is showed again if latex_show_urls is not ``None``
* 2176: sphinx.ext.graphviz: use <object> instead of <img> to embed svg
* 967: Fix SVG inheritance diagram is not hyperlinked (clickable)
* 1237: Fix footnotes not working in definition list in LaTeX
* 2168: Fix raw directive does not work for text writer
* 2171: Fix cannot linkcheck url with unicode
* 2182: LaTeX: support image file names with more than 1 dots
* 2189: Fix previous sibling link for first file in subdirectory uses last
file, not intended previous from root toctree
* 2003: Fix decode error under python2 (only) when ``make linkcheck`` is run
* 2186: Fix LaTeX output of \mathbb in math
* 1480, 2188: LaTeX: Support math in section titles
* 2071: Fix same footnote in more than two section titles => LaTeX/PDF Bug
* 2040: Fix UnicodeDecodeError in sphinx-apidoc when author contains non-ascii
characters
* 2193: Fix shutil.SameFileError if source directory and destination directory
are same
* 2178: Fix unparsable C++ cross-reference when referencing a function with
``:cpp:any:``
* 2206: Fix Sphinx latex doc build failed due to a footnotes
* 2201: Fix wrong table caption for tables with over 30 rows
* 2213: Set <blockquote> in the classic theme to fit with <p>
* 1815: Fix linkcheck does not raise an exception if warniserror set to true
and link is broken
* 2197: Fix slightly cryptic error message for missing index.rst file
* 1894: Unlisted phony targets in quickstart Makefile
* 2125: Fix unifies behavior of collapsed fields (``GroupedField`` and
``TypedField``)
* 1408: Check latex_logo validity before copying
* 771: Fix latex output doesn't set tocdepth
* 1820: On Windows, console coloring is broken with colorama version 0.3.3.
Now Sphinx use colorama>=0.3.5 to avoid this problem.
* 2072: Fix footnotes in chapter-titles do not appear in PDF output
* 1580: Fix paragraphs in longtable don't work in Latex output
* 1366: Fix centered image not centered in latex
* 1860: Fix man page using ``:samp:`` with braces - font doesn't reset
* 1610: Sphinx crashes in Japanese indexing in some systems
* Fix Sphinx crashes if mecab initialization failed
* 2160: Fix broken TOC of PDFs if section includes an image
* 2172: Fix dysfunctional admonition ``\pylightbox`` in sphinx.sty. Thanks to
jfbu.
* 2198,2205: ``make gettext`` generate broken msgid for definition lists.
* 2062: Escape characters in doctests are treated incorrectly with Python 2.
* 2225: Fix if the option does not begin with dash, linking is not performed
* 2226: Fix math is not HTML-encoded when :nowrap: is given (jsmath, mathjax)
* 1601, 2220: '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.
* 2229: Fix no warning is given for unknown options

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

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

* 2177: Fix parallel hangs
* 2012: Fix exception occurred if ``numfig_format`` is invalid
* 2142: Provide non-minified JS code in ``sphinx/search/non-minified-js/*.js``
for source distribution on PyPI.
* 2148: Error while building devhelp target with non-ASCII document.

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

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

* 1935: Make "numfig_format" overridable in latex_elements.

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

* 1976: Avoid "2.0" version of Babel because it doesn't work with Windows
environment.
* Add a "default.css" stylesheet (which imports "classic.css") for compatibility
* 1788: graphviz extension raises exception when caption option is present.
* 1789: ``:pyobject:`` option of ``literalinclude`` directive includes
following lines after class definitions
* 1790: ``literalinclude`` strips empty lines at the head and tail
* 1802: load plugin themes automatically when theme.conf use it as 'inherit'.
Thanks to Takayuki Hirai.
* 1794: custom theme extended from ``alabaster`` or ``sphinx_rtd_theme``
can't find base theme.
* 1834: compatibility for Docutils 0.13: handle_io_errors keyword argument for
docutils.io.FileInput cause TypeError.
* 1823: '.' as <module_path> for sphinx-apidoc cause an unfriendly error. Now
'.' is converted to absolute path automatically.
* Fix a crash when setting up extensions which do not support metadata.
* 1784: Provide non-minified JS code in ``sphinx/search/non-minified-js/*.js``
* 1822, 1892: Fix regression for 1061. autosummary can't generate doc for
imported members since Sphinx 1.3b3. Thanks to Eric Larson.
* 1793, 1819: "see also" misses a linebreak in text output. Thanks to Takayuki
Hirai.
* 1780, 1866: "make text" shows "class" keyword twice. Thanks to Takayuki
Hirai.
* 1871: Fix for LaTeX output of tables with one column and multirows.
* Work around the lack of the HTMLParserError exception in Python 3.5.
* 1949: Use ``safe_getattr`` in the coverage builder to avoid aborting with
descriptors that have custom behavior.
* 1915: Do not generate smart quotes in doc field type annotations.
* 1796: On py3, automated .mo building caused UnicodeDecodeError.
* 1923: Use babel features only if the babel latex element is nonempty.
* 1942: Fix a KeyError in websupport.
* 1903: Fix strange id generation for glossary terms.
* ``make text`` will crush if a definition list item has more than 1 classifiers
as: ``term : classifier1 : classifier2``.
* 1855: make gettext generates broken po file for definition lists with
classifier.
* 1869: Fix problems when dealing with files containing non-ASCII characters.
Thanks to Marvin Schmidt.
* 1798: Fix building LaTeX with references in titles.
* 1725: On py2 environment, doctest with using non-ASCII characters causes
``'ascii' codec can't decode byte`` exception.
* 1540: Fix RuntimeError with circular referenced toctree
* 1983: i18n translation feature breaks references which uses section name.
* 1990: Use caption of toctree to title of \tableofcontents in LaTeX
* 1987: Fix ampersand is ignored in ``:menuselection:`` and ``:guilabel:``
on LaTeX builder
* 1994: 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.
* 1989: "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.
* On Py2 environment, conf.py that is generated by sphinx-quickstart should have
u prefixed config value for 'version' and 'release'.
* 2102: On Windows + Py3, using ``|today|`` and non-ASCII date format will
raise UnicodeEncodeError.
* 1974: UnboundLocalError: local variable 'domain' referenced before assignment
when using ``any`` role and ``sphinx.ext.intersphinx`` in same time.
* 2121: multiple words search doesn't find pages when words across on the page
title and the page content.
* 1884, 1885: plug-in html themes cannot inherit another plug-in theme. Thanks
to Suzumizaki.
* 1818: ``sphinx.ext.todo`` directive generates broken html class attribute as
'admonition-' when :confval:`language` is specified with non-ASCII linguistic
area like 'ru' or 'ja'. To fix this, now ``todo`` directive can use
``:class:`` option.
* 2140: Fix footnotes in table has broken in LaTeX
* 2127: MecabBinder for html searching feature doesn't work with Python 3.
Thanks to Tomoko Uchida.

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

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

* 1769: allows generating quickstart files/dirs for destination dir that
doesn't overwrite existent files/dirs. Thanks to WAKAYAMA shirou.
* 1773: sphinx-quickstart doesn't accept non-ASCII character as a option
argument.
* 1766: the message "least Python 2.6 to run" is at best misleading.
* 1772: cross reference in docstrings like ``:param .write:`` breaks building.
* 1770, 1774: ``literalinclude`` with empty file occurs exception. Thanks to
Takayuki Hirai.
* 1777: Sphinx 1.3 can't load extra theme. Thanks to tell-k.
* 1776: ``source_suffix = ['.rst']`` cause unfriendly error on prior version.
* 1771: automated .mo building doesn't work properly.
* 1783: Autodoc: Python2 Allow unicode string in ``__all__``.
Thanks to Jens Hedegaard Nielsen.
* 1781: Setting ``html_domain_indices`` to a list raises a type check warnings.

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

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

* Roles ``ref``, ``term`` and ``menusel`` now don't generate :durole:`emphasis`
nodes anymore. If you want to keep italic style, adapt your stylesheet.
* Role ``numref`` uses ``%s`` as special character to indicate position of
figure numbers instead ` symbol.

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

* Add convenience directives and roles to the C++ domain:
directive ``cpp:var`` as alias for ``cpp:member``, role ``:cpp:var`` as alias
for ``:cpp:member``, and role ``any`` for cross-reference to any C++
declaraction. 1577, 1744
* The :confval:`source_suffix` config value can now be a list of multiple
suffixes.
* Add the ability to specify source parsers by source suffix with the
:confval:`source_parsers` config value.
* 1675: A new builder, AppleHelpBuilder, has been added that builds Apple
Help Books.

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

* 1.3b3 change breaks a previous gettext output that contains duplicated
msgid such as "foo bar" and "version changes in 1.3: foo bar".
* 1745: latex builder cause maximum recursion depth exceeded when a
footnote has a footnote mark itself.
* 1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6.
* 1658, 1750: No link created (and warning given) if option does not
begin with -, / or +. Thanks to Takayuki Hirai.
* 1753: C++, added missing support for more complex declarations.
* 1700: Add ``:caption:`` option for :rst:dir:`toctree`.
* 1742: ``:name:`` option is provided for :rst:dir:`toctree`,
:rst:dir:`code-block` and :rst:dir:`literalinclude` directives.
* 1756: Incorrect section titles in search that was introduced from 1.3b3.
* 1746: C++, fixed name lookup procedure, and added missing lookups in
declarations.
* 1765: C++, fix old id generation to use fully qualified names.

Documentation
-------------

* 1651: Add ``vartype`` field description for python domain.