Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > comp.lang.python > #16834

Re: Documentation using Sphinx

Date 2011-12-08 15:17 +0000
From Andrea Crotti <andrea.crotti.0@gmail.com>
Subject Re: Documentation using Sphinx
References <6107ecd2-9acf-4334-8877-ca8b9ff90752@b14g2000prn.googlegroups.com>
Newsgroups comp.lang.python
Message-ID <mailman.3416.1323357481.27778.python-list@python.org> (permalink)

Show all headers | 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 | NextPrevious 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