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 Epub info
--------- ---------
The epub builder is currently in an experimental stage. It has only been tested The following list gives some hints for the creation of epub files:
with the Sphinx documentation itself. If you want to create epubs, here are
some notes:
* Split the text into several files. The longer the individual HTML files are, * 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 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 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 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/ .. _Epubcheck: http://code.google.com/p/epubcheck/
.. _Calibre: http://calibre-ebook.com/ .. _Calibre: http://calibre-ebook.com/
.. _FBreader: http://www.fbreader.org/ .. _FBreader: http://www.fbreader.org/

4
doc/markup/misc.rst
View File

@@ -180,10 +180,10 @@ Including content based on tags
parentheses (like ``html and (latex or draft)``) are supported. parentheses (like ``html and (latex or draft)``) are supported.
The *format* and the *name* of the current builder (``html``, ``latex`` or 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 format and name explicit, they are also added with the prefix ``format_`` and
``builder_``, e.g. the epub builder defines the tags ``html``, ``epub``, ``builder_``, e.g. the epub builder defines the tags ``html``, ``epub``,
``format_html`` and ``builder_epub``. ``format_html`` and ``builder_epub``.
.. versionadded:: 0.6 .. versionadded:: 0.6
.. versionchanged:: 1.2 .. versionchanged:: 1.2