[GRASS-dev] sphinx documentation for lib python

[Luca Delucchi]

On 26 June 2014 17:21, Vaclav Petras <wenzeslaus at gmail.com> wrote:
> Hi Luca,
>

Hi Vaclav,

> On Thu, Jun 26, 2014 at 11:02 AM, Luca Delucchi <lucadeluge at gmail.com>
> wrote:
>>
>> Hi devs,
>>
>> I'm going to start to work on sphinx documentation for lib/python in
>> the next week/s.
>> I would like to know which directory do you like to have on the docs.
>> I think that all the directories (ctypes, imaging, pydispatch,
>> pygrass, script, temporal) should be in.
>>
> I'm not sure about how it works with ctypes but all the other should be
> there for sure, although pydispatch and imaging are little bit special since
> they partially contain 3rd party code.
>

Yes, after sent the email I had your same doubt with ctypes. I'll try
and see what happen :-)

>> what do you think?
>>
>> PS
>> I would like also to modify pygrass documentation removing all method,
>> classes and function documentation (moving it to the new programming
>> documentation) and leaving it only the user documentation with
>> example. is it ok for you?
>>
> I'm not exactly sure what do you mean by that. I know that there are
> different possibilities how to approach this. Can please you provide more
> examples and describe it more (e.g. draft the rules how doc should be
> written)?
>

I take as example raster [0]. For RastRow there is a description with
example and after start the documentation about RastRow class.
I would like to keep the description with example there and move the
RastRow class documentation to the new lib/python documentation. This
because I think that http://grass.osgeo.org/grass71/manuals/pygrass/
should be for user and the new lib/python documentation is for
developers and the two documentations should be separated. Is it more
clear now?

> Thank you,
> Vaclav

[0] http://grass.osgeo.org/grass71/manuals/pygrass/raster.html

-- 
ciao
Luca

http://gis.cri.fmach.it/delucchi/
www.lucadelu.org