Repository navigation
documentation in epub format #49614
Description
| BPO | 5364 |
|---|---|
| Nosy | @birkenfeld, @rhettinger, @terryjreedy, @orsenthil, @sandrotosi |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2009-04-05.15:24:03.586>
created_at = <Date 2009-02-25.10:19:36.594>
labels = ['type-feature', 'docs']
title = 'documentation in epub format'
updated_at = <Date 2012-11-05.12:52:49.428>
user = 'https://bugs.python.org/wrobell'bugs.python.org fields:
activity = <Date 2012-11-05.12:52:49.428>
actor = 'csillag'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2009-04-05.15:24:03.586>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2009-02-25.10:19:36.594>
creator = 'wrobell'
dependencies = []
files = ['27893']
hgrepos = []
issue_num = 5364
keywords = ['patch']
message_count = 12.0
messages = ['82698', '82699', '82702', '82703', '82844', '82866', '83054', '85518', '148860', '148865', '148866', '174903']
nosy_count = 10.0
nosy_names = ['georg.brandl', 'rhettinger', 'terry.reedy', 'orsenthil', 'wrobell', 'biny', 'abdelazer', 'sandro.tosi', 'James.Polley', 'csillag']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue5364'
versions = []
Activity
wrobell commentedon Feb 25, 2009
python documentation can be downloaded in pdf format (a4, us letter),
html and text plain. they are useful for printing and computer based
viewing, but not so good to read on ebook hardware/software
(i.e. sony prs-{505,700} or stanza ebook reader).
it would be nice if python documentation could be downloaded in epub
format, which is open format for ebooks
i believe that major publishers are providing ebooks in epub format
as well
orsenthil commentedon Feb 25, 2009
I got into thinking if sphinx-dev or docutils be the best place for this ticket?
Python Documentation is nothing but ReStructured text and it is
required to create a rst2epub that would convert restructured text to
epub format. If you are already aware of any such tool, please point
it to restructured text project for integration.
Python Bug tracker might be a wrong place for this feature request, IMO.
wrobell commentedon Feb 25, 2009
probably sphinx/docutils "deserve" their own tickets, but appropriate
tools support will not guarantee, that documentation in epub format is
going to be published on
if documentation won't be published in this format, then i suggest
to close the ticket. but the decision is not up to me. :)
orsenthil commentedon Feb 25, 2009
On Wed, Feb 25, 2009 at 5:12 PM, wrobell <report@bugs.python.org> wrote:
I agree with your points and I would wait for Georg's call on this ticket.
It would definitely help if you have already raised any tickets at
docutils or looked for a tool which does rst2epub.
birkenfeld commentedon Feb 27, 2009
Well, the request is valid, so I'll leave this open here.
Since the format seems to me to be nothing but XHTML with a bit of extra
markup around it, it would be quite easy to write a builder for Sphinx
(by copying from the HTML help one) to do it. Would you like to try that?
terryjreedy commentedon Feb 27, 2009
A few days ago, Tim O'Reilly wrote a column in Forbes
http://www.forbes.com/2009/02/22/kindle-oreilly-ebooks-technology-breakthroughs_oreilly.html
promoting epub and noting that his computer book company is starting to
use it.
I got the same impression: xhtml + extra markup for mobile readers.
abdelazer commentedon Mar 3, 2009
ePub is indeed based heavily on XHTML 1.1 and CSS and uses a fairly
simple ZIP container. Having written DocBook->ePub tools, I'm happy to
help anyone interested in doing rst2epub.
birkenfeld commentedon Apr 5, 2009
In any case, this belongs in the Sphinx tracker:
http://bitbucket.org/birkenfeld/sphinx/issue/140/
JamesPolley commentedon Dec 5, 2011
So http://bitbucket.org/birkenfeld/sphinx/issue/140/ has now been closed; sphinx happily builds epub.
However, the python docs are still not available for download in epub format from http://docs.python.org/download.html, which was the original request in this issue.
JamesPolley commentedon Dec 5, 2011
It looks like the first release that had epub support was 1.0; docs.python.org is still using 0.6.7, according to the footer on the bottom of the page.
I suspect that this is (A) pending the upgrade to 1.0.0, which is (B) more difficult than it sounds like, or at least, needs someone to make a concerted effort, and (C) should automatically just happen (or at least, be fairly trivial) once the move to the new version happens.
sandrotosi commentedon Dec 5, 2011
Hello James,
please note that EPUB is already available for Python 3 documentation: http://docs.python.org/py3k/download.html . We will probably make it available also for 2.7 when I'll find the time to work on upgrading sphinx on 2.7 branch.
csillag commentedon Nov 5, 2012
I have prepared a patch to build the 2.7 docs in EPUB format, too.
(Since this was already done on Python 3; this is only a very simple backport of a few lines in a Makefile, a readme and a HTML download page.)