Skip to content

Commit f378c69

Browse files
aerkalovaerkalov
committed
BK-1615 Update documentation about MOBI publishing
1 parent b767444 commit f378c69

4 files changed

Lines changed: 47 additions & 0 deletions

File tree

‎docs/deployment/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ Deployment
1515
postgresql
1616
createbooktype
1717
upgrade_instruction
18+
mobi

‎docs/deployment/mobi.rst‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
====
2+
MOBI
3+
====
4+
5+
Booktype can export books in `MOBI format <https://en.wikipedia.org/wiki/Mobipocket>`_ using external 3rd party software. User has choice between `Calibre`_ (GNU General Public License v3) and `KindleGen`_ from Amazon. `Calibre`_ is enabled by default.
6+
7+
User is required to install 3rd party software on its own.
8+
9+
Use Calibre
10+
===========
11+
12+
Configuration options::
13+
14+
MOBI_CONVERT = "calibre"
15+
CALIBRE_PATH = "ebook-convert"
16+
CALIBRE_ARGS = ""
17+
18+
19+
**MOBI_CONVERT** instructs Booktype to use `Calibre`_ for MOBI export.
20+
21+
**CALIBRE_PATH** defines full path to the command line tool used for conversion. By default it is configured as if `Calibre`_ is installed on the system and globally accessible. In case it is not, user can define full path to the ebook-convert tool.
22+
23+
**CALIBRE_ARGS** defines extra arguments for the ebook-convert tool. Extra arguments are available here: http://manual.calibre-ebook.com/cli/ebook-convert.html.
24+
25+
26+
Use KindleGen
27+
=============
28+
29+
Configuration options::
30+
31+
MOBI_CONVERT = "kindlegen"
32+
KINDLEGEN_PATH = "kindlegen"
33+
34+
**MOBI_CONVERT** instructs Booktype to use `KindleGen`_ for MOBI export.
35+
36+
**KINDLEGEN_PATH** defines full path to the command line tool used for conversion. By default it is configured as if `KindleGen`_ is installed on the system and globally accessible. In case it is not, user can define full path to the kindlegen tool.
37+
38+
39+
.. _Calibre: http://calibre-ebook.com
40+
.. _KindleGen: http://www.amazon.com/gp/feature.html?docId=1000765211

‎docs/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ Deployment
3535
Supervisor |
3636
RabbitMQ
3737

38+
* **Publishing**
39+
:doc:`MOBI <deployment/mobi>`
40+
3841
* **Scripts:**
3942
:doc:`Createbooktype <deployment/createbooktype>` |
4043
Backup

‎lib/booktype/skeleton/base_settings.py.original‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ EMAIL_PORT = 25
5555
#EMAIL_HOST_PASSWORD = ''
5656
#EMAIL_USE_TLS = False
5757

58+
# MOBI EXPORT
59+
MOBI_CONVERT = "calibre"
60+
5861
# MPDF RENDERER SETTINGS
5962

6063
MPDF_DIR = ''

0 commit comments

Comments
 (0)