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

Groups > comp.lang.python > #16827 > unrolled thread

Documentation using Sphinx

Back to article view | Back to comp.lang.python

Contents

  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

#16827 — Documentation using Sphinx

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 ???.

[toc] | [next] | [standalone]

#16834

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.

[toc] | [prev] | [standalone]

Back to top | Article view | comp.lang.python

csiph-web