Documentation using Sphinx

S

sajuptpm

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

Andrea Crotti

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.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

No members online now.

Forum statistics

Threads
473,772
Messages
2,569,593
Members
45,112
Latest member
VinayKumar Nevatia
Top