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

Add a documentation for epub3 builder.

Browse Source
This commit is contained in:
SHIMIZU Taku 2016-01-17 22:59:59 +09:00
parent 5cc52f46c2
commit bca16504d1
2 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/builders.rst
View File

@ -140,6 +140,26 @@ The builder's "name" must be given to the **-b** command-line option of
.. autoattribute:: supported_image_types
.. module:: sphinx.builders.epub3
.. class:: Epub3Builder
This builder produces the same output as the standalone HTML builder, but
also generates an *epub* file for ebook readers. See :ref:`epub-faq` for
details about it. For definition of the epub format, have a look at
`<http://idpf.org/epub>`_ or `<http://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
.. autoattribute:: supported_image_types
.. versionadded:: 1.4
.. module:: sphinx.builders.latex
.. class:: LaTeXBuilder

22
doc/config.rst
View File

@ -1145,11 +1145,25 @@ the `Dublin Core metadata <http://dublincore.org/>`_.
The title of the document. It defaults to the :confval:`html_title` option
but can be set independently for epub creation.
.. confval:: epub3_description
The description of the document. The default value is ``''``.
.. versionadded:: 1.4
.. confval:: epub_author
The author of the document. This is put in the Dublin Core metadata. The
default value is ``'unknown'``.
.. confval:: epub3_contributor
The name of a person, organization, etc. that played a secondary role in
the creation of the content of an EPUB Publication. The default value is
``'unknown'``.
.. versionadded:: 1.4
.. confval:: epub_language
The language of the document. This is put in the Dublin Core metadata. The
@ -1305,6 +1319,14 @@ the `Dublin Core metadata <http://dublincore.org/>`_.
.. versionadded:: 1.2
.. confval:: epub3_page_progression_direction
The global direction in which the content flows.
Allowed values are ltr (left-to-right), rtl (right-to-left) and default.
The default value is ``'ltr'``.
.. versionadded:: 1.4
.. _latex-options:
Options for LaTeX output