Path: csiph.com!x330-a1.tempe.blueboxinc.net!usenet.pasdenom.info!news.chainon-marquant.org!news-transit.tcx.org.uk!rt.uk.eu.org!newsfeed.xs4all.nl!newsfeed6.news.xs4all.nl!xs4all!newsgate.cistron.nl!newsgate.news.xs4all.nl!post.news.xs4all.nl!not-for-mail Return-Path: X-Original-To: python-list@python.org Delivered-To: python-list@mail.python.org X-Spam-Status: OK 0.002 X-Spam-Evidence: '*H*': 1.00; '*S*': 0.00; 'subject:: [': 0.02; 'python': 0.08; '(it': 0.09; 'foo': 0.09; 'sits': 0.09; 'sphinx': 0.09; 'output': 0.10; 'subject:] ': 0.14; 'entries': 0.15; 'curve.': 0.16; 'highlighting': 0.16; 'imo,': 0.16; 'nick': 0.16; 'otoh,': 0.16; 'sucks': 0.16; 'toc': 0.16; 'url:pocoo': 0.16; 'url:sphinx': 0.16; 'cc:addr:python-list': 0.16; 'syntax': 0.16; 'examples': 0.16; 'wrote:': 0.18; 'header:In-Reply-To:1': 0.22; 'required.': 0.23; '(though': 0.23; 'extensively': 0.23; 'indexing': 0.23; 'somehow': 0.23; 'index': 0.24; 'code': 0.25; '(in': 0.26; "i'm": 0.26; 'books': 0.27; 'somebody': 0.28; 'bit': 0.28; 'html,': 0.29; 'cc:addr:python.org': 0.29; 'url:wiki': 0.29; '(the': 0.30; "i've": 0.31; 'source': 0.31; 'does': 0.32; "isn't": 0.33; 'actually': 0.33; 'there': 0.33; 'it?': 0.33; 'latter': 0.34; 'regular': 0.35; '...': 0.36; 'cc:2**1': 0.36; 'but': 0.37; "there's": 0.37; 'think': 0.37; 'received:org': 0.38; 'url:en': 0.39; 'url:org': 0.39; '(with': 0.39; "it's": 0.40; 'raw': 0.40; 'more': 0.61; 'greetings,': 0.66; 'details.': 0.72; 'reply-to:no real name:2**0': 0.72; 'automatic': 0.72; 'quality': 0.75; 'header :Reply-to:1': 0.84; 'subject:Book': 0.84; 'edwards': 0.91 X-Quarantine-ID: X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "Cc" To: Grant Edwards From: Nick Dokos Subject: Re: [OT] Book authoring In-Reply-To: Message from Grant Edwards of "Fri, 09 Dec 2011 15:13:46 GMT." References: <14110199.662.1323401134730.JavaMail.geo-discussion-forums@vbbeq1> Organization: HPCS X-Mailer: MH-E 8.3; nmh 1.3; GNU Emacs 24.0.90 Date: Fri, 09 Dec 2011 10:43:27 -0500 Sender: nick@dokosmarshall.org Cc: python-list@python.org X-BeenThere: python-list@python.org X-Mailman-Version: 2.1.12 Precedence: list Reply-To: nicholas.dokos@hp.com List-Id: General discussion list for the Python programming language List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Newsgroups: comp.lang.python Message-ID: Lines: 41 NNTP-Posting-Host: 2001:888:2000:d::a6 X-Trace: 1323446012 news.xs4all.nl 6932 [2001:888:2000:d::a6]:57725 X-Complaints-To: abuse@xs4all.nl Xref: x330-a1.tempe.blueboxinc.net comp.lang.python:16918 Grant Edwards wrote: > On 2011-12-09, Miki Tebeka wrote: > > Greetings, > > > > Any recommendations for a book authoring system that supports the following: > > 1. Code examples (with syntax highlighting and line numbers) > > 2. Output HTML, PDF, ePub ... > > 3. Automatic TOC and index > > 4. Search (in HTML) - this is a "nice to have" > > http://en.wikipedia.org/wiki/Lightweight_markup_language > > I've used asciidoc extensively and reStructuredText a little. Asciidoc > will produce all the formats you mentioned (though I've only refularly > used HTML and PDF). reStructuredText is what's used for Python docs > isn't it? > > > Can I somehow use Sphinx? > > Don't know what Sphinx is. > I think Sphinx is used for the python docs: it sits atop rST and does all the transformations/processing to produce the desired output ( http://sphinx.pocoo.org ) > And there's always the old stand-by LaTeX, but it's a bit more > heavyweight with more of a learning curve. OTOH, it does produce > text-book quality output. > There is also orgmode, which has been used for a few books (http://orgmode.org ). I know it does HTML and PDF (the latter through latex), but I'm not sure about ePub: ISTR somebody actually did ePub for his book but I don't remember details. The indexing is manual: add #+index: foo entries as required. But in general, imo, automatic indexing for books sucks raw eggs (it works much better for highly regular source code like the python source base). Nick