epydoc is python specific and uses custom markup in the doc strings. I think is was pre Rest. It might be a good place to start looking. There might be some guidelines in the sphinx docs about this as well.
On 4/22/10, JAGANADH G <jagana...@gmail.com> wrote: > On Thu, Apr 22, 2010 at 12:58 PM, Senthil Kumaran > <orsent...@gmail.com>wrote: > >> On Thu, Apr 22, 2010 at 12:29:30PM +0530, JAGANADH G wrote: >> > >> > I am looking for a guide to learn the technique of writing such kind of >> code >> > document in my module. >> > >> >> The Documentation for modules and functions is called 'docstrings'. >> >> PEP: 257 - is the 'immortalized' pep for docstring conventions. >> Also look at pep-0007 and pep-0008 for coding standards. >> >> And google for docutils, restructured text, you might get all the >> references you want. >> >> On a site note, the one you pointed out seems to be project specific >> and not standard docstrings. >> >> > Ya it is from the project > http://bitbucket.org/jagan/bioreadernltk/src/tip/bioreader.py > > I will try the documents suggested by you. I got the idea now . > > Thanks for the help > > -- > ********************************** > JAGANADH G > http://jaganadhg.freeflux.net/blog > _______________________________________________ > BangPypers mailing list > BangPypers@python.org > http://mail.python.org/mailman/listinfo/bangpypers > -- ~noufal http://nibrahim.net.in _______________________________________________ BangPypers mailing list BangPypers@python.org http://mail.python.org/mailman/listinfo/bangpypers
