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 wrote:
> On Thu, Apr 22, 2010 at 12:58 PM, Senthil Kumaran
> wrote:
On Thu, Apr 22, 2010 at 12:58 PM, Senthil Kumaran 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 'do
On Thu, Apr 22, 2010 at 12:57 PM, steve wrote:
> On 04/22/2010 12:29 PM, JAGANADH G wrote:
>
>> Dear All
>>
>> where can I find some guide/guidelines for code documentation like this
>>
>>
>> >>> single_record.pmid
>> u'7024555'
>> single_record +
>>
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 conventi
On 04/22/2010 12:29 PM, JAGANADH G wrote:
Dear All
where can I find some guide/guidelines for code documentation like this
>>> single_record.pmid
u'7024555'
single_record +
- B{.title}
- B{.pmid}
- B{.Abs} I{(abstracts)}
Dear All
where can I find some guide/guidelines for code documentation like this
>>> single_record.pmid
u'7024555'
single_record +
- B{.title}
- B{.pmid}
- B{.Abs} I{(abstracts)}
- B{.year}
I am looking for a guide to
