IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch '1.6-release'

Browse Source
This commit is contained in:
jfbu 2017-05-03 11:40:21 +02:00
commit 3cff7faf77
6 changed files with 52 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CHANGES
View File

@ -51,6 +51,9 @@ Release 1.6 beta3 (in development)
Incompatible changes
--------------------
* LaTeX package ``eqparbox`` is not used and not loaded by Sphinx anymore
* LaTeX package ``multirow`` is not used and not loaded by Sphinx anymore
Deprecated
----------
@ -62,6 +65,10 @@ Bugs fixed
* #3588: No compact (p tag) html output in the i18n document build even when
:confval:`html_compact_lists` is True.
* The ``make latexpdf`` (which uses ``latexmk``) aborted earlier in case of
LaTeX errors than was the case with 1.5 series. Now, ``LATEXMKOPTS``
variable is provided whose default value ``-f`` mimics former behaviour.
(refs #3695)
Testing
--------
@ -72,7 +79,8 @@ Release 1.6 beta2 (released Apr 29, 2017)
Incompatible changes
--------------------
* #3345: Replace the custom smartypants code with docutils' smart_quotes
* #3345: Replace the custom smartypants code with Docutils' smart_quotes.
Thanks to Dmitry Shachnev, and to Günter Milde at Docutils.
Deprecated
----------

25
doc/builders.rst
View File

@ -182,6 +182,31 @@ The builder's "name" must be given to the **-b** command-line option of
.. versionchanged:: 1.6
Use of ``latexmk`` on GNU/Linux or Mac OS X.
Since 1.6, ``make latexpdf`` (or ``make -C "<builddir>/latex"`` after a
``sphinx-build`` run) uses ``latexmk`` (on GNU/Linux and Mac OS X).
It invokes it with option ``-f`` which attempts to complete targets
even in case of LaTeX processing errors. This can be overridden via
``LATEXMKOPTS`` variable, for example:
.. code-block:: console
make latexpdf LATEXMKOPTS=""
The ``pdflatex`` calls themselves obey the ``LATEXOPTS`` variable whose
default is ``--interaction=nonstopmode`` (same as ``-interaction
nonstopmode``.) In order to stop the
compilation on first error one can use ``--halt-on-error``.
Example:
.. code-block:: console
make latexpdf LATEXMKOPTS="-silent" LATEXOPTS="--halt-on-error"
In case the first ``pdflatex`` run aborts with an error, this will stop
further ``latexmk`` processing (no ``-f`` option). The console output
will be kept to a bare minimum during target processing (``-silent``).
.. autoattribute:: name
.. autoattribute:: format

16
sphinx/texinputs/Makefile_t
View File

@ -14,8 +14,10 @@ ALLIMGS = $(wildcard *.png *.gif *.jpg *.jpeg)
# Prefix for archive names
ARCHIVEPRREFIX =
# Additional LaTeX options
LATEXOPTS =
# Additional LaTeX options (used via latexmkrc/latexmkjarc file)
LATEXOPTS = --interaction=nonstopmode
# Additional latexmk options
LATEXMKOPTS = -f
# format: pdf or dvi
FMT = pdf
@ -40,11 +42,11 @@ PDFLATEX = $(LATEX)
{% if latex_engine == 'platex' -%}
%.dvi: %.tex $(ALLIMGS) FORCE_MAKE
for f in *.pdf; do extractbb "$$f"; done
$(LATEX) $(LATEXOPTS) '$<'
$(LATEX) $(LATEXMKOPTS) '$<'
{% elif latex_engine != 'xelatex' -%}
%.dvi: %.tex FORCE_MAKE
$(LATEX) $(LATEXOPTS) '$<'
$(LATEX) $(LATEXMKOPTS) '$<'
{% endif -%}
%.ps: %.dvi
@ -56,7 +58,9 @@ PDFLATEX = $(LATEX)
{%- else -%}
%.pdf: %.tex FORCE_MAKE
{%- endif %}
$(PDFLATEX) $(LATEXOPTS) '$<'
$(PDFLATEX) $(LATEXMKOPTS) '$<'
all: $(ALLPDF)
all-dvi: $(ALLDVI)
@ -64,8 +68,6 @@ all-ps: $(ALLPS)
all-pdf: $(ALLPDF)
all: $(ALLPDF)
zip: all-$(FMT)
mkdir $(ARCHIVEPREFIX)docs-$(FMT)
cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT)

2
sphinx/texinputs/latexmkjarc
View File

@ -1,4 +1,4 @@
$latex = 'platex --halt-on-error --interaction=nonstopmode -kanji=utf8 %O %S';
$latex = 'platex $LATEXOPTS -kanji=utf8 %O %S';
$dvipdf = 'dvipdfmx %O -o %D %S';
$makeindex = 'rm -f %D; mendex -U -f -d %B.dic -s python.ist %S || echo "mendex exited with error code $? (ignoring)" && : >> %D';
add_cus_dep( "glo", "gls", 0, "makeglo" );

8
sphinx/texinputs/latexmkrc
View File

@ -1,7 +1,7 @@
$latex = 'latex --halt-on-error --interaction=nonstopmode %O %S';
$pdflatex = 'pdflatex --halt-on-error --interaction=nonstopmode %O %S';
$lualatex = 'lualatex --halt-on-error --interaction=nonstopmode %O %S';
$xelatex = 'xelatex --no-pdf --halt-on-error --interaction=nonstopmode %O %S';
$latex = 'latex $LATEXOPTS %O %S';
$pdflatex = 'pdflatex $LATEXOPTS %O %S';
$lualatex = 'lualatex $LATEXOPTS %O %S';
$xelatex = 'xelatex --no-pdf $LATEXOPTS %O %S';
$makeindex = 'makeindex -s python.ist %O -o %D %S';
add_cus_dep( "glo", "gls", 0, "makeglo" );
sub makeglo {

7
sphinx/websupport/__init__.py
View File

@ -19,9 +19,10 @@ try:
from sphinxcontrib.websupport.search import BaseSearch, SEARCH_ADAPTERS # NOQA
from sphinxcontrib.websupport.storage import StorageBackend # NOQA
warnings.warn('sphinx.websupport module is now provided as sphinxcontrib-webuspport. '
'sphinx.websupport will be removed in Sphinx-2.0. Please use it instaed',
warnings.warn('sphinx.websupport module is now provided as sphinxcontrib-websupport. '
'sphinx.websupport will be removed at Sphinx-2.0. '
'Please use the package instead.',
RemovedInSphinx20Warning)
except ImportError:
warnings.warn('Since Sphinx-1.6, sphinx.websupport module is now separated to '
'sphinxcontrib-webuspport package. Please add it into your dependency list.')
'sphinxcontrib-websupport package. Please add it into your dependency list.')