Merge branch 'stable' into 1.6-release

This commit is contained in:
jfbu 2017-05-05 13:33:50 +02:00
commit 79412051d2
5 changed files with 19 additions and 10 deletions

View File

@ -251,6 +251,8 @@ Bugs fixed
* #3657: EPUB builder crashes if document startswith genindex exists * #3657: EPUB builder crashes if document startswith genindex exists
* #3588: No compact (p tag) html output in the i18n document build even when * #3588: No compact (p tag) html output in the i18n document build even when
:confval:`html_compact_lists` is True. :confval:`html_compact_lists` is True.
* #3685: AttributeError when using 3rd party domains
* #3702: LaTeX writer styles figure legends with a hard-coded ``\small``
Testing Testing
-------- --------
@ -451,10 +453,8 @@ Incompatible changes
* QtHelpBuilder doens't generate search page (ref: #2352) * QtHelpBuilder doens't generate search page (ref: #2352)
* QtHelpBuilder uses ``nonav`` theme instead of default one * QtHelpBuilder uses ``nonav`` theme instead of default one
to improve readability. to improve readability.
* latex: To provide good default settings to Japanese docs, Sphinx uses ``jsbook`` * latex: To provide good default settings to Japanese documents, Sphinx uses
as a docclass by default if the ``language`` is ``ja``. ``jreport`` and ``jsbook`` as docclass if :confval:`language` is
* latex: To provide good default settings to Japanese docs, Sphinx uses
``jreport`` and ``jsbooks`` as a docclass by default if the ``language`` is
``ja``. ``ja``.
* ``sphinx-quickstart`` now allows a project version is empty * ``sphinx-quickstart`` now allows a project version is empty
* Fix :download: role on epub/qthelp builder. They ignore the role because they don't support it. * Fix :download: role on epub/qthelp builder. They ignore the role because they don't support it.
@ -494,6 +494,7 @@ Incompatible changes
* Emit warnings that will be deprecated in Sphinx 1.6 by default. * Emit warnings that will be deprecated in Sphinx 1.6 by default.
Users can change the behavior by setting the environment variable Users can change the behavior by setting the environment variable
PYTHONWARNINGS. Please refer :ref:`when-deprecation-warnings-are-displayed`. PYTHONWARNINGS. Please refer :ref:`when-deprecation-warnings-are-displayed`.
* #2454: new JavaScript variable ``SOURCELINK_SUFFIX`` is added
Deprecated Deprecated
---------- ----------

View File

@ -438,7 +438,14 @@ Let us now list some macros from the package file
the new macros are wrappers of the formerly hard-coded ``\texttt``, the new macros are wrappers of the formerly hard-coded ``\texttt``,
``\emph``, ... The default definitions can be found in ``\emph``, ... The default definitions can be found in
:file:`sphinx.sty`. :file:`sphinx.sty`.
- paragraph level environments: for each admonition type ``<foo>``, the - a :dudir:`figure` may have an optional legend with arbitrary body
elements: they are rendered in a ``sphinxlegend`` environment. The default
definition issues ``\small``, and ends with ``\par``.
.. versionadded:: 1.5.6
formerly, the ``\small`` was hardcoded in LaTeX writer and the ending
``\par`` was lacking.
- for each admonition type ``<foo>``, the
used environment is named ``sphinx<foo>``. They may be ``\renewenvironment`` used environment is named ``sphinx<foo>``. They may be ``\renewenvironment``
'd individually, and must then be defined with one argument (it is the heading 'd individually, and must then be defined with one argument (it is the heading
of the notice, for example ``Warning:`` for :dudir:`warning` directive, if of the notice, for example ``Warning:`` for :dudir:`warning` directive, if

View File

@ -1406,6 +1406,8 @@
\protected\def\sphinxstyleliteralstrong {\sphinxbfcode} \protected\def\sphinxstyleliteralstrong {\sphinxbfcode}
\protected\def\sphinxstyleabbreviation {\textsc} \protected\def\sphinxstyleabbreviation {\textsc}
\protected\def\sphinxstyleliteralintitle {\sphinxcode} \protected\def\sphinxstyleliteralintitle {\sphinxcode}
% figure legend comes after caption and may contain arbitrary body elements
\newenvironment{sphinxlegend}{\par\small}{\par}
% Tell TeX about pathological hyphenation cases: % Tell TeX about pathological hyphenation cases:
\hyphenation{Base-HTTP-Re-quest-Hand-ler} \hyphenation{Base-HTTP-Re-quest-Hand-ler}

View File

@ -359,7 +359,8 @@ class DocFieldTransformer(object):
else: else:
fieldtype, content = entry fieldtype, content = entry
fieldtypes = types.get(fieldtype.name, {}) fieldtypes = types.get(fieldtype.name, {})
env = self.directive.state.document.settings.env
new_list += fieldtype.make_field(fieldtypes, self.directive.domain, new_list += fieldtype.make_field(fieldtypes, self.directive.domain,
content, env=self.directive.env) content, env=env)
node.replace_self(new_list) node.replace_self(new_list)

View File

@ -1833,12 +1833,10 @@ class LaTeXTranslator(nodes.NodeVisitor):
self.unrestrict_footnote(node) self.unrestrict_footnote(node)
def visit_legend(self, node): def visit_legend(self, node):
# type: (nodes.Node) -> None self.body.append('\n\\begin{sphinxlegend}')
self.body.append('{\\small ')
def depart_legend(self, node): def depart_legend(self, node):
# type: (nodes.Node) -> None self.body.append('\\end{sphinxlegend}\n')
self.body.append('}')
def visit_admonition(self, node): def visit_admonition(self, node):
# type: (nodes.Node) -> None # type: (nodes.Node) -> None