Use epub3 builder by default. And the old epub builder is renamed to epub2.

This commit is contained in:
Takeshi KOMIYA 2016-08-15 16:32:38 +09:00
parent 2b5c7057a7
commit 69d1dfaade
5 changed files with 13 additions and 6 deletions

View File

@ -42,6 +42,7 @@ Incompatible changes
* Use make-mode of ``sphinx-quickstart`` by default. To disable this, use
``-M`` option
* Fix ``genindex.html`` to satisfy xhtml standard.
* Use epub3 builder by default. And the old epub builder is renamed to epub2.
Features added
--------------

View File

@ -140,6 +140,11 @@ The builder's "name" must be given to the **-b** command-line option of
.. autoattribute:: supported_image_types
.. deprecated:: 1.5
Since Sphinx-1.5, the epub3 builder is used for the default builder of epub.
Now EpubBuilder is renamed to epub2.
.. module:: sphinx.builders.epub3
.. class:: Epub3Builder
@ -149,9 +154,6 @@ The builder's "name" must be given to the **-b** command-line option of
`<http://idpf.org/epub>`_ or `<https://en.wikipedia.org/wiki/EPUB>`_.
The builder creates *EPUB 3* files.
This builder is still *experimental* because it can't generate valid EPUB 3
files.
.. autoattribute:: name
.. autoattribute:: format
@ -160,6 +162,10 @@ The builder's "name" must be given to the **-b** command-line option of
.. versionadded:: 1.4
.. versionchanged:: 1.5
Since Sphinx-1.5, the epub3 builder is used for the default builder of epub.
.. module:: sphinx.builders.latex
.. class:: LaTeXBuilder

View File

@ -176,7 +176,7 @@ class EpubBuilder(StandaloneHTMLBuilder):
META-INF/container.xml. Afterwards, all necessary files are zipped to an
epub file.
"""
name = 'epub'
name = 'epub2'
# don't copy the reST source
copysource = False

View File

@ -95,7 +95,7 @@ class Epub3Builder(EpubBuilder):
and META-INF/container.xml. Afterwards, all necessary files are zipped to
an epub file.
"""
name = 'epub3'
name = 'epub'
navigation_doc_template = NAVIGATION_DOC_TEMPLATE
navlist_template = NAVLIST_TEMPLATE

View File

@ -70,7 +70,7 @@ def test_build_all():
# note: no 'html' - if it's ok with dirhtml it's ok with html
for buildername in ['dirhtml', 'singlehtml', 'latex', 'texinfo', 'pickle',
'json', 'text', 'htmlhelp', 'qthelp', 'epub', 'epub3',
'json', 'text', 'htmlhelp', 'qthelp', 'epub2', 'epub',
'applehelp', 'changes', 'xml', 'pseudoxml', 'man',
'linkcheck']:
yield verify_build, buildername, srcdir