Path: csiph.com!eeepc.pasdenom.info!news.pasdenom.info!news.dougwise.org!aioe.org!feeder.news-service.com!xlned.com!feeder7.xlned.com!news2.euro.net!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.003 X-Spam-Evidence: '*H*': 0.99; '*S*': 0.00; 'python,': 0.01; 'documenting': 0.07; 'hettinger': 0.07; 'python': 0.08; 'sphinx': 0.09; 'subject:Source': 0.09; 'url:github': 0.09; 'url:pocoo': 0.09; 'url:sphinx': 0.09; 'am,': 0.13; 'extension': 0.13; 'wrote:': 0.14; 'url:html)': 0.16; 'cc:no real name:2**0': 0.17; 'putting': 0.18; 'code.': 0.19; 'cc:2**0': 0.21; 'raymond': 0.21; 'examples': 0.22; 'jan': 0.22; 'header:In-Reply-To:1': 0.23; 'cc:addr:python-list': 0.24; 'sections': 0.24; 'code': 0.25; 'language': 0.26; "i'm": 0.28; 'message-id:@mail.gmail.com': 0.29; 'called': 0.29; 'project:': 0.30; 'cc:addr:python.org': 0.30; 'hoping': 0.31; 'url:mailman': 0.31; 'fri,': 0.31; 'source': 0.31; 'received:209.85.161.46': 0.32; 'received:mail- fx0-f46.google.com': 0.32; 'received:209.85.161': 0.33; 'skip:" 20': 0.33; 'things': 0.34; 'used': 0.36; 'docs': 0.37; 'received:209.85': 0.38; 'received:google.com': 0.38; 'url:org': 0.38; 'subject:: ': 0.39; 'url:python': 0.39; 'charset:windows-1252': 0.64; 'here': 0.64; 'view': 0.65; 'link': 0.66; 'clicking': 0.82; '10:32': 0.84; 'routinely': 0.84; 'url:2011': 0.84; 'url:28': 0.84; 'trend': 0.91 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc:content-type:content-transfer-encoding; bh=EnHGRnW9ekEl/0APQZbBLKPglfPw+hcDjQ+boAhPCo0=; b=BHwk1aTT1gSYXExNgViKK9XcGPk/1cdPlWDSpbxVHAF67J9kmKyoLM9//Cb/4Usrhj ryFnm0xK0BWQB1oZNA/gMURBW4dKsoD9WLtBjEtj7g8Ml65sGA5rYRj1Eakhd6vXDSQd crtUpe7Yd70IHxQ2kiPd+aW3sX3vKiYuXLjs0= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type:content-transfer-encoding; b=ocn293EaphEQAbg2ttA9cJrelvg/i79jl7t83qNlRFD7WMR9QMv4voCUYTkzhsrAIK gQReZjEoRxV6OVlJX9ELbMpKVf5+n7SmUCpIHhgy2A2h0pW8C9uW9wjyUQnkslL4dhsE YXXtcsITIs/keqBHFUgNspWrcozwoDmg1X6r4= MIME-Version: 1.0 In-Reply-To: <094f6fc5-7242-46c7-b454-4cb29d0c6ef9@q40g2000prh.googlegroups.com> References: <094f6fc5-7242-46c7-b454-4cb29d0c6ef9@q40g2000prh.googlegroups.com> From: TP Date: Sat, 29 Jan 2011 03:22:48 -0800 Subject: Re: Use the Source Luke To: Raymond Hettinger Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: quoted-printable Cc: python-list@python.org X-BeenThere: python-list@python.org X-Mailman-Version: 2.1.12 Precedence: list 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: 29 NNTP-Posting-Host: 82.94.164.166 X-Trace: 1296300222 news.xs4all.nl 41103 [::ffff:82.94.164.166]:46958 X-Complaints-To: abuse@xs4all.nl Xref: csiph.com comp.lang.python:55806 On Fri, Jan 28, 2011 at 10:32 AM, Raymond Hettinger wrote: > I hoping a new trend will start with dev's putting direct > source code links in their documentation: > > =A0http://rhettinger.wordpress.com/2011/01/28/open-your-source-more/ > > I'm looking for more examples of projects that routinely > link their docs back into relavant sections of code. > Have any of you all seen other examples besides > the Go language docs and the Python docs? > > > Raymond > -- > http://mail.python.org/mailman/listinfo/python-list > The Sphinx Python Documentation Generator (http://sphinx.pocoo.org/index.html), used for documenting lots of things other than Python, has an extension called "sphinx.ext.viewcode =96 Add links to highlighted source code" (http://sphinx.pocoo.org/ext/viewcode.html). You can see my use of it here on a small PyQt project: http://tpgit.github.com/MDIImageViewer/imageviewer.html. You can even view the Sphinx documentation "code" by clicking the "Show Source" link on the left. -- TP