Sphinx

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

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

* Support requests-2.0.0 (experimental) (refs: 3367)
* (latex) PDF page margin dimensions may be customized (refs: 3387)
* ``literalinclude`` directive allows combination of ``:pyobject:`` and
``:lines:`` options (refs: 3416)
* 3400: make-mode doesn't use subprocess on building docs

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

* 3370: the caption of code-block is not picked up for translation
* LaTeX: :confval:`release` is not escaped (refs: 3362)
* 3364: sphinx-quickstart prompts overflow on Console with 80 chars width
* since 1.5, PDF's TOC and bookmarks lack an entry for general Index
(refs: 3383)
* 3392: ``'releasename'`` in :confval:`latex_elements` is not working
* 3356: Page layout for Japanese ``'manual'`` docclass has a shorter text area
* 3394: When ``'pointsize'`` is not ``10pt``, Japanese ``'manual'`` document
gets wrong PDF page dimensions
* 3399: quickstart: conf.py was not overwritten by template
* 3366: option directive does not allow punctuations
* 3410: return code in :confval:`release` breaks html search
* 3427: autodoc: memory addresses are not stripped on Windows
* 3428: xetex build tests fail due to fontspec v2.6 defining ``\strong``
* 3349: Result of ``IndexBuilder.load()`` is broken
* 3450: &nbsp is appeared in EPUB docs
* 3418: Search button is misaligned in nature and pyramid theme
* 3421: Could not translate a caption of tables
* 3552: linkcheck raises UnboundLocalError

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

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

* Dependency requirement updates: requests 2.4.0 or above (refs: 3268, 3310)

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

* 3241: emit latex warning if buggy titlesec (ref 3210)
* 3194: Refer the $MAKE environment variable to determine ``make`` command
* Emit warning for nested numbered toctrees (refs: 3142)
* 978: ``intersphinx_mapping`` also allows a list as a parameter
* 3340: (LaTeX) long lines in :dudir:`parsed-literal` are wrapped like in
:rst:dir:`code-block`, inline math and footnotes are fully functional.

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

* 3246: xapian search adapter crashes
* 3253: In Py2 environment, building another locale with a non-captioned
toctree produces ``None`` captions
* 185: References to section title including raw node has broken
* 3255: In Py3.4 environment, autodoc doesn't support documentation for
attributes of Enum class correctly.
* 3261: ``latex_use_parts`` makes Sphinx crash
* The warning type ``misc.highlighting_failure`` does not work
* 3294: ``add_latex_package()`` make crashes non-LaTeX builders
* The caption of table are rendered as invalid HTML (refs: 3287)
* 3268: Sphinx crashes with requests package from Debian jessie
* 3284: Sphinx crashes on parallel build with an extension which raises
unserializable exception
* 3315: Bibliography crashes on latex build with docclass 'memoir'
* 3328: Could not refer rubric implicitly
* 3329: emit warnings if po file is invalid and can't read it. Also writing mo
* 3337: Ugly rendering of definition list term's classifier
* 3335: gettext does not extract field_name of a field in a field_list
* 2952: C++, fix refs to operator() functions.
* Fix Unicode super- and subscript digits in :rst:dir:`code-block` and
parsed-literal LaTeX output (ref 3342)
* LaTeX writer: leave ``"`` character inside parsed-literal as is (ref 3341)
* 3234: intersphinx failed for encoded inventories
* 3158: too much space after captions in PDF output
* 3317: An URL in parsed-literal contents gets wrongly rendered in PDF if
with hyphen
* LaTeX crash if the filename of an image inserted in parsed-literal
via a substitution contains an hyphen (ref 3340)
* LaTeX rendering of inserted footnotes in parsed-literal is wrong (ref 3340)
* Inline math in parsed-literal is not rendered well by LaTeX (ref 3340)
* 3308: Parsed-literals don't wrap very long lines with pdf builder (ref 3340)
* 3295: Could not import extension sphinx.builders.linkcheck
* 3285: autosummary: asterisks are escaped twice
* LaTeX, pass dvipdfm option to geometry package for Japanese documents (ref
3363)
* Fix parselinenos() could not parse left half open range (cf. "-4")

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

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

* 3214: Allow to suppress "unknown mimetype" warnings from epub builder using
:confval:`suppress_warnings`.

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

* 3195: Can not build in parallel
* 3198: AttributeError is raised when toctree has 'self'
* 3211: Remove untranslated Sphinx locale catalogs (it was covered by
untranslated it_IT)
* 3212: HTML Builders crashes with Docutils 0.13
* 3207: more latex problems with references inside parsed-literal directive
(``\DUrole``)
* 3205: sphinx.util.requests crashes with old pyOpenSSL (< 0.14)
* 3220: KeyError when having a duplicate citation
* 3200: LaTeX: xref inside desc_name not allowed
* 3228: ``build_sphinx`` command crashes when missing dependency
* 2469: Ignore updates of catalog files for gettext builder. Thanks to
Hiroshi Ohkubo.
* 3183: Randomized jump box order in generated index page.

* 3069: Even if ``'babel'`` key is set to empty string, LaTeX output contains
one ``\addto\captions...``
* 3123: user ``'babel'`` key setting is not obeyed anymore
* 3155: Fix JavaScript for ``html_sourcelink_suffix`` fails with IE and Opera
* 3085: keep current directory after breaking build documentation. Thanks to
Timotheus Kampik.
* 3181: pLaTeX crashes with a section contains endash
* 3180: latex: add stretch/shrink between successive singleline or
multipleline cpp signatures (ref 3072)
* 3128: globing images does not support .svgz file
* 3015: fix a broken test on Windows.
* 1843: Fix documentation of descriptor classes that have a custom metaclass.
Thanks to Erik Bray.
* 3190: util.split_docinfo fails to parse multi-line field bodies
* 3024, 3037: In Python3, application.Sphinx._log crushed when the log message
cannot be encoded into console encoding.

Testing
-------

* To simplify, Sphinx uses external mock package even if ``unittest.mock`` exists.

* 2432: Fix unwanted * between varargs and keyword only args. Thanks to Alex
Grönholm.
* 3062: Failed to build PDF using 1.5a2 (undefined ``\hypersetup`` for
Japanese documents since PR3030)
* Better rendering of multiline signatures in html.
* 777: LaTeX output "too deeply nested" (ref 3096)
* Let LaTeX image inclusion obey ``scale`` before textwidth fit (ref 2865,
3059)
* 3019: LaTeX fails on description of C function with arguments (ref 3083)
* fix latex inline literals where ``< > -`` gobbled a space

* 2810: Problems with pdflatex in an Italian document
* Use ``latex_elements.papersize`` to specify papersize of LaTeX in Makefile
* 2988: linkcheck: retry with GET request if denied HEAD request
* 2990: linkcheck raises "Can't convert 'bytes' object to str implicitly" error
if linkcheck_anchors enabled
* 3004: Invalid link types "top" and "up" are used
* 3009: Bad rendering of parsed-literals in LaTeX since Sphinx 1.4.4
* 3000: ``option`` directive generates invalid HTML anchors
* 2984: Invalid HTML has been generated if ``html_split_index`` enabled
* 2986: themes/basic/defindex.html should be changed for html5 friendly
* 2987: Invalid HTML has been generated if multiple IDs are assigned to a list
* 2891: HTML search does not provide all the results
* 1986: Title in PDF Output
* 147: Problem with latex chapter style
* 3018: LaTeX problem with page layout dimensions and chapter titles
* Fix an issue with ``\pysigline`` in LaTeX style file (ref 3023)
* 3038: ``sphinx.ext.math*`` raises TypeError if labels are duplicated
* 3031: incompatibility with LaTeX package ``tocloft``
* 3003: literal blocks in footnotes are not supported by Latex
* 3047: spacing before footnote in pdf output is not coherent and allows breaks
* 3045: HTML search index creator should ignore "raw" content if now html
* 3039: English stemmer returns wrong word if the word is capitalized
* Fix make-mode Makefile template (ref 3056, 2936)