Re: Documentation using Sphinx

Path	csiph.com!x330-a1.tempe.blueboxinc.net!usenet.pasdenom.info!aioe.org!news.stack.nl!newsfeed.xs4all.nl!newsfeed5.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail
Return-Path	<andrea.crotti.0@gmail.com>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.014
X-Spam-Evidence	'H': 0.97; 'S': 0.00; 'example:': 0.03; 'subject:using': 0.04; 'doc,': 0.09; 'sphinx': 0.09; 'directory)': 0.16; 'document,': 0.16; 'cc:addr:python-list': 0.16; 'received:74.125.82.44': 0.16; 'received:mail-ww0-f44.google.com': 0.16; 'wrote:': 0.18; 'file,': 0.19; 'cc:no real name:20': 0.20; 'trying': 0.21; 'header:In-Reply-To:1': 0.22; 'cc:20': 0.24; 'code': 0.25; 'classes': 0.26; 'facility': 0.29; 'cc:addr:python.org': 0.29; 'pm,': 0.29; 'modules,': 0.30; 'quickly.': 0.30; 'source': 0.31; 'does': 0.32; 'hi,': 0.32; 'message-id:@gmail.com': 0.33; 'header:User-Agent:1': 0.33; 'anything': 0.34; 'received:74.125.82': 0.35; 'folder': 0.35; 'modules': 0.35; 'project': 0.35; 'received:74.125': 0.37; 'received:google.com': 0.37; 'using': 0.38; 'received:10.0.0': 0.38; 'should': 0.39; 'tool': 0.39; 'choose': 0.62; 'here': 0.65; 'browsing': 0.77; 'click': 0.80; '02:09': 0.84; 'plugin.': 0.84
DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=message-id:date:from:user-agent:mime-version:to:cc:subject :references:in-reply-to:content-type:content-transfer-encoding; bh=NaJ9PhHSHsH3VRIz/w1W43ISaEemcLq2slkYPMII4oc=; b=wh8Gp+25DEdT440trUcwNbkBqKUp8/JAT4lG3Hs3wcyEXJ7KFZx6OKXCkniyXhx6GG xlaKw3OJjKrgqPc+NzxzNSDvefSgjDKjDpY5a2WFa4dZ6g6nJeGLO66lLPlWG/CvbAnf NR+5c49W/GN5BSCbxSfCzvar5rxq4SagVnXYk=
Date	Thu, 08 Dec 2011 15:17:56 +0000
From	Andrea Crotti <andrea.crotti.0@gmail.com>
User-Agent	Mozilla/5.0 (X11; Linux x86_64; rv:8.0) Gecko/20111108 Thunderbird/8.0
MIME-Version	1.0
To	sajuptpm <sajuptpm@gmail.com>
Subject	Re: Documentation using Sphinx
References	<6107ecd2-9acf-4334-8877-ca8b9ff90752@b14g2000prn.googlegroups.com>
In-Reply-To	<6107ecd2-9acf-4334-8877-ca8b9ff90752@b14g2000prn.googlegroups.com>
Content-Type	text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding	7bit
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 <python-list.python.org>
List-Unsubscribe	<http://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive	<http://mail.python.org/pipermail/python-list>
List-Post	<mailto:python-list@python.org>
List-Help	<mailto:python-list-request@python.org?subject=help>
List-Subscribe	<http://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups	comp.lang.python
Message-ID	<mailman.3416.1323357481.27778.python-list@python.org> (permalink)
Lines	12
NNTP-Posting-Host	2001:888:2000:d::a6
X-Trace	1323357481 news.xs4all.nl 6869 [2001:888:2000:d::a6]:56599
X-Complaints-To	abuse@xs4all.nl
Xref	x330-a1.tempe.blueboxinc.net comp.lang.python:16834

Show key headers only | View raw

On 12/08/2011 02:09 PM, sajuptpm wrote:
> Hi,
> I am trying source code documentation using Sphinx. Here i have to
> copy paste all modules in to *.rst file, that is painful. Have any way
> to create documentation (doc for all modules, classes and methods in
> the project directory) from project folder quickly. I also plannig to
> add a code browsing facility in the document, for example: code should
> display if we click on a method/class name in the doc, does sphinx has
> this feature???  or what tool i have to choose for that ???.

You should never copy and paste anything ;)
Have a look at the autodoc plugin.

Back to comp.lang.python | Previous | Next — Previous in thread | Find similar | Unroll thread

Thread

Documentation using Sphinx sajuptpm <sajuptpm@gmail.com> - 2011-12-08 06:09 -0800
  Re: Documentation using Sphinx Andrea Crotti <andrea.crotti.0@gmail.com> - 2011-12-08 15:17 +0000

csiph-web