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

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

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

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

12
doc/builders.rst
View File

@ -140,6 +140,11 @@ The builder's "name" must be given to the **-b** command-line option of
.. autoattribute:: supported_image_types .. 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 .. module:: sphinx.builders.epub3
.. class:: Epub3Builder .. 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>`_. `<http://idpf.org/epub>`_ or `<https://en.wikipedia.org/wiki/EPUB>`_.
The builder creates *EPUB 3* files. The builder creates *EPUB 3* files.
This builder is still *experimental* because it can't generate valid EPUB 3
files.
.. autoattribute:: name .. autoattribute:: name
.. autoattribute:: format .. autoattribute:: format
@ -160,6 +162,10 @@ The builder's "name" must be given to the **-b** command-line option of
.. versionadded:: 1.4 .. 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 .. module:: sphinx.builders.latex
.. class:: LaTeXBuilder .. class:: LaTeXBuilder

2
sphinx/builders/epub.py
View File

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

2
sphinx/builders/epub3.py
View File

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

2
tests/test_build.py
View File

@ -70,7 +70,7 @@ def test_build_all():
# note: no 'html' - if it's ok with dirhtml it's ok with html # note: no 'html' - if it's ok with dirhtml it's ok with html
for buildername in ['dirhtml', 'singlehtml', 'latex', 'texinfo', 'pickle', 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', 'applehelp', 'changes', 'xml', 'pseudoxml', 'man',
'linkcheck']: 'linkcheck']:
yield verify_build, buildername, srcdir yield verify_build, buildername, srcdir