Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Flask documentation in ePub/Mobi format as well #388

Closed
fmaida opened this Issue · 12 comments

6 participants

@fmaida

In the future please consider to publish the flask documentation not only in PDF but also in formats easily readable by an ebook reader like Kindle or Nook. At least for me it's much easier to read longer documentation on a e-ink device rather than a monitor, and PDF are rendered quite awfully on my Kindle 3g.

I see that there's a builder for Sphinx that permits to build epub files along with their HTML versions here: http://sphinx.pocoo.org/builders.html#module-sphinx.builders.epub

ePub would be a easier format to convert, through Calibre we could have a 1:1 conversion in MOBI format too.

Thank you

@rduplain
Collaborator

I uploaded a .epub, linked to the front page of the docs:
http://flask.pocoo.org/docs/flask-docs.epub

@fmaida, could you try out this ePub and let me know if it works well for you?
Thanks,

Ron

@fmaida

Thank you very much. I've just downloaded and converted it into MOBI format because unfortunately my Kindle cannot handle directly the ePub format, but I have always seen that Calibre can render a perfect copy of an ePub so I guess that if the MOBI file is OK then the original ePub will be OK too.

Here are some random screenshots I've taken from my Kindle device:

https://skitch.com/fmaida/g5wi9/screen-shot-26466
https://skitch.com/fmaida/g5wsd/screen-shot-26467
https://skitch.com/fmaida/g5wsp/screen-shot-26468

From a quick check by reading the first pages with the internal ebook reader that is available within Calibre it seems that the ePub file is a perfect rendition of the HTML documentation; I tried some links and they were all working properly. I've uploaded the documentation into my Kindle and I'm bringing it with me so I'll read it a little bit while I'm going to work and coming back, and tonight I'll be able to tell you if there are any problems with the format.

Meanwhile, thank you again because today you saved my eyes from reading 250+ pages on a monitor ;-)

@rduplain
Collaborator

Thanks for the screenshots, looks sharp. Code listing do not have much room, but that's the only problem I see. calibre provides a command-line tool which we can use to automate publishing a .mobi: ebook-convert Flask.epub Flask.mobi. Do you have any thoughts on conversion options? Listed here:

http://manual.calibre-ebook.com/cli/ebook-convert-2.html#epub-input-to-mobi-output

I uploaded a conversion with the defaults. Could you try it?
http://flask.pocoo.org/docs/flask-docs.mobi

If it doesn't look good, we might consider converting from another format, e.g. the .pdf. Conversion formats:
http://manual.calibre-ebook.com/cli/ebook-convert.html

@fmaida

I've read the first 20 pages so far and I haven't found any issue: text is formatted properly, there's a correct summary and all the links I've tried were working. From what I've seen everything is perfect so far.
It's true that judging from the screenshots there isn't a lot of space for the source code, but I usually read books with a really large font and with a smaller font the text is still clear and readable and there's a lot of extra room for the code.

I just checked your conversion too and it's almost identical to mine.
The only (really minor) glitch that I've found so far in the meta-data is that you haven't specified an author for the ebook, but everything else is excellent. That's a really great work, thank you!

@rduplain
Collaborator

Updated:
http://flask.pocoo.org/docs/flask-docs.mobi

This is the output of:

ebook-convert Flask.epub Flask.mobi --cover http://flask.pocoo.org/docs/_images/logo-full.png --authors 'Armin Ronacher'

The cover doesn't look stellar, but at least it's not a screenshot of the debugger. If this looks good enough to @fmaida, I'll automate the .mobi creation.

@fmaida

It's perfect!

@rduplain
Collaborator

Looks like ebook-convert is converting .epub to HTML, then to .mobi. We can experiment with different conversions if we need improvements. For now, it's automated via make upload-docs, running the conversion server-side to ease developer requirements.

Cover could use some love, but it works.

ebook-convert provides many formats, if we need others.

@rduplain rduplain closed this
@rduplain
Collaborator

Linked to the front page of the docs:
http://flask.pocoo.org/docs/

@susanBuck

FYI link to .mobi is now a 404

@vav1288

Hi! Link to .mobi is still 404
Link to epub is downloading .zip

@BenGosub

Is there a recent epub/mobi version of the documentation?

@davidism

Duplicate of pocoo/metaflask#7.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.