diff --git a/doc/faq.rst b/doc/faq.rst index e1c95b08e..ff74be1c8 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/ diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst index 86b625dbc..10ba491e9 100644 --- a/doc/markup/misc.rst +++ b/doc/markup/misc.rst @@ -180,10 +180,10 @@ Including content based on tags parentheses (like ``html and (latex or draft)``) are supported. The *format* and the *name* of the current builder (``html``, ``latex`` or - ``text``) are always set as a tag [#]_. To make the distinction between + ``text``) are always set as a tag [#]_. To make the distinction between format and name explicit, they are also added with the prefix ``format_`` and ``builder_``, e.g. the epub builder defines the tags ``html``, ``epub``, - ``format_html`` and ``builder_epub``. + ``format_html`` and ``builder_epub``. .. versionadded:: 0.6 .. versionchanged:: 1.2