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

More docs cleanup; add hint for the epub cover page

Browse Source
This commit is contained in:
Roland Meister
2013-06-07 20:48:14 +02:00
parent 2f5b7b8db1
commit cc909ab2a9
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/faq.rst
View File

@@ -126,9 +126,7 @@ Google Analytics
Epub info
---------
The epub builder is currently in an experimental stage. It has only been tested
with the Sphinx documentation itself. If you want to create epubs, here are
some notes:
The following list gives some hints for the creation of epub files:
* Split the text into several files. The longer the individual HTML files are,
the longer it takes the ebook reader to render them. In extreme cases, the
@@ -162,6 +160,12 @@ some notes:
included. This sometimes applies to appendixes, e.g. the glossary or
the indices. You can add them with the :confval:`epub_post_files` option.
* The handling of the epub cover page differs from the reStructuredText
procedure which automatically resolves image paths and puts the images
into the ``_images`` directory. For the epub cover page put the image in the
:confval:`html_static_path` directory and reference it with its full path in
the :confval:`epub_cover` config option.
.. _Epubcheck: http://code.google.com/p/epubcheck/
.. _Calibre: http://calibre-ebook.com/
.. _FBreader: http://www.fbreader.org/