diff options
| author | Georg Brandl <georg@python.org> | 2009-12-29 12:32:42 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-12-29 12:32:42 +0100 |
| commit | ed446a2b73b799458e314e326178036e50210286 (patch) | |
| tree | 1867b8f75fa1f5c25983974816037347a3cb0876 /doc/faq.rst | |
| parent | 5346bd30f96daa3888936c8038069d02435f85df (diff) | |
| download | sphinx-ed446a2b73b799458e314e326178036e50210286.tar.gz | |
Review of epub builder. Add a separate "epub_theme" config value for selecting a different theme.
Diffstat (limited to 'doc/faq.rst')
| -rw-r--r-- | doc/faq.rst | 60 |
1 files changed, 27 insertions, 33 deletions
diff --git a/doc/faq.rst b/doc/faq.rst index 46a714dd..20b9b62c 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -54,46 +54,40 @@ github pages Sphinx HTML output. +.. _api role: http://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py +.. _xhtml to reST: http://docutils.sourceforge.net/sandbox/xhtml2rest/xhtml2rest.py + + Epub ---- -The EpubBuilder 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 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: -* 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 rendering can take up to one minute. +* 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 + rendering can take up to one minute. -* Try to minimize the markup. This also pays in rendering time. +* Try to minimize the markup. This also pays in rendering time. -* For some readers you can use embedded or external fonts - using the CSS ``@font-face`` directive. - This is *extremely* useful for code listings which are often cut - at the right margin. The default Courier font (or variant) is quite - wide and you can only display up to 60 characters on a line. - If you replace it with a narrower font, you can get more characters - on a line. You may even use - `fontforge <http://fontforge.sourceforge.net/>`_ - and create narrow variants - of some free font. In my case I get up to 70 characters on a line. +* For some readers you can use embedded or external fonts using the CSS + ``@font-face`` directive. This is *extremely* useful for code listings which + are often cut at the right margin. The default Courier font (or variant) is + quite wide and you can only display up to 60 characters on a line. If you + replace it with a narrower font, you can get more characters on a line. You + may even use `FontForge <http://fontforge.sourceforge.net/>`_ and create + narrow variants of some free font. In my case I get up to 70 characters on a + line. You may have to experiment a little until you get reasonable results. -* Test the created epubs. You can use several alternatives. - The ones I am aware of are - Epubcheck - (`http://code.google.com/p/epubcheck/ - <http://code.google.com/p/epubcheck/>`_), - Calibre - (`http://calibre-ebook.com/ <http://calibre-ebook.com/>`_), - FBreader (`http://www.fbreader.org/ <http://www.fbreader.org/>`_, - although it does not render the CSS), and - Bookworm (`http://bookworm.oreilly.com/ <http://bookworm.oreilly.com/>`_). - For bookworm you can download the source from - `http://code.google.com/p/threepress/ <http://code.google.com/p/threepress/>`_ - and run you own local server. +* Test the created epubs. You can use several alternatives. The ones I am aware + of are Epubcheck_, Calibre_, FBreader_ (although it does not render the CSS), + and Bookworm_. For bookworm you can download the source from + http://code.google.com/p/threepress/ and run your own local server. - -.. _api role: http://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py -.. _xhtml to reST: http://docutils.sourceforge.net/sandbox/xhtml2rest/xhtml2rest.py +.. _Epubcheck: http://code.google.com/p/epubcheck/ +.. _Calibre: http://calibre-ebook.com/ +.. _FBreader: http://www.fbreader.org/ +.. _Bookworm: http://bookworm.oreilly.com/ |
