1. Matt McClure
  2. sphinx


Roland Meister  committed f9e407c

More docs cleanup; add hint for the epub cover page

  • Participants
  • Parent commits 162c4c8
  • Branches default

Comments (0)

Files changed (2)

File doc/faq.rst

View file
  • Ignore whitespace
 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
   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/

File doc/markup/misc.rst

View file
  • Ignore whitespace
    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