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 with http://bitbucket.org/rolmei/sphinx-epub/

Browse Source
This commit is contained in:
Georg Brandl
2010-08-26 16:23:18 +00:00
parent ad759f54c1 3b42bf8c27
commit e5be4a841c
5 changed files with 101 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/config.rst
View File

@@ -744,11 +744,27 @@ the `Dublin Core metadata <http://dublincore.org/>`_.
A unique identifier for the document. This is put in the Dublin Core
metadata. You may use a random string. The default value is ``'unknown'``.
.. confval:: epub_cover
The cover page information. This is a tuple containing the filenames of
the cover image and the html template. The rendered html cover page is
inserted as the first item in the spine in :file:`content.opf`. If the
template filename is empty, no html cover page is created. No cover at all
is created if the tuple is empty. Examples::
epub_cover = ('_static/cover.png', 'epub-cover.html')
epub_cover = ('_static/cover.png', '')
epub_cover = ()
The default value is ``()``.
.. versionadded:: 1.1
.. confval:: epub_pre_files
Additional files that should be inserted before the text generated by
Sphinx. It is a list of tuples containing the file name and the title.
Example::
If the title is empty, no entry is added to :file:`toc.ncx`. Example::
epub_pre_files = [
('index.html', 'Welcome'),
@@ -760,7 +776,8 @@ the `Dublin Core metadata <http://dublincore.org/>`_.
Additional files that should be inserted after the text generated by Sphinx.
It is a list of tuples containing the file name and the title. This option
can be used to add an appendix. The default value is ``[]``.
can be used to add an appendix. If the title is empty, no entry is added
to :file:`toc.ncx`. The default value is ``[]``.
.. confval:: epub_exclude_files