diff options
| author | Roland Meister <devnull@localhost> | 2013-06-07 20:48:14 +0200 |
|---|---|---|
| committer | Roland Meister <devnull@localhost> | 2013-06-07 20:48:14 +0200 |
| commit | 1930b22c95d99f5ad63423c5e40c050fbdc364f4 (patch) | |
| tree | 98b1e6b2b6e70e021ef475ab51e86f7e9dd8b730 /doc/faq.rst | |
| parent | 752be4acb34a2f010e19f09cee9c34d4a92d0f0a (diff) | |
| download | sphinx-1930b22c95d99f5ad63423c5e40c050fbdc364f4.tar.gz | |
More docs cleanup; add hint for the epub cover page
Diffstat (limited to 'doc/faq.rst')
| -rw-r--r-- | doc/faq.rst | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/faq.rst b/doc/faq.rst index e1c95b08..ff74be1c 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -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/ |