#2435: finish replacement of python api doxygen doc by sphinx
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: defect | Status: new
Priority: major | Milestone: 7.1.0
Component: Docs | Version: unspecified
Keywords: doxygen, python, sphinx | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------
Comment(by wenzeslaus):
For the files with a lot of text, I prefer to preserve the history. I'm
not sure what exactly is possible in SVN. Revert the change in SVN for the
particular file and then do `svn mv` and do the changes?
I'm not sure what to do with lists of functions and classes. There was a
lot of these lists in the Doxygen documentation. They are probably useless
and always outdated. However, some subset(s) might be useful, such as the
most used functions are: ...
#2435: finish replacement of python api doxygen doc by sphinx
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: defect | Status: new
Priority: major | Milestone: 7.1.0
Component: Docs | Version: unspecified
Keywords: doxygen, python, sphinx | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------
Comment(by wenzeslaus):
I added back the documentation for wxGUI toolboxes in r62172. I did the
conversion from Doxygen to Sphinx manually.
After the recent SVN fun with g.remove I was not trying to retrieve the
old version using SVN I guess the history wouldn't be preserved anyway.
Instead, I referenced the original commit r56035 in the commit message.
I removed the standalone Sphix documentation added in r62138 which was
created by conversion of Doxygen generated HTML to ODF and to Sphinx as
described in comment:4:ticket:2423.
#2435: finish replacement of python api doxygen doc by sphinx
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: defect | Status: new
Priority: major | Milestone: 7.1.0
Component: Docs | Version: unspecified
Keywords: doxygen, python, sphinx | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------
Comment(by huhabla):
Replying to [comment:2 wenzeslaus]:
> I added back the documentation for wxGUI toolboxes in r62172. I did the
conversion from Doxygen to Sphinx manually.
>
> After the recent SVN fun with g.remove I was not trying to retrieve the
old version using SVN I guess the history wouldn't be preserved anyway.
Instead, I referenced the original commit r56035 in the commit message.
>
> I removed the standalone Sphix documentation added in r62138 which was
created by conversion of Doxygen generated HTML to ODF and to Sphinx as
described in comment:4:ticket:2423.
>
> So one file done:
>
> * source:grass/trunk/gui/wxpython/wxguitoolboxes.dox@57001
>
> Six more to go:
>
> * source:grass/trunk/gui/wxpython/wxpythonlib.dox@56035
> * source:grass/trunk/lib/python/imaging/imaginglib.dox@58181
> * source:grass/trunk/lib/python/pydispatch/pydispatchlib.dox@55394
> * source:grass/trunk/lib/python/pygrass/pygrasslib.dox@60031
> * source:grass/trunk/lib/python/script/pythonlib.dox@62015
> * source:grass/trunk/lib/python/temporal/pythontemporallib.dox@58915
The temporal framework doxygen documentation was converted to Sphinx in
r62121,
hence only 5 more to go:
#2435: finish replacement of python api doxygen doc by sphinx
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: defect | Status: new
Priority: major | Milestone: 7.1.0
Component: Docs | Version: unspecified
Keywords: doxygen, python, sphinx | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------
Comment(by lucadelu):
Replying to [comment:4 neteler]:
> Luca has done a lot of cleanup. I have added a tiny intro (to be
expanded).
>
> All online at: http://grass.osgeo.org/grass71/manuals/libpython/
>
> (updated bi-weekly through a cronjob)
Changeset r62706 backported all the Python Sphinx doc and removed the dox
files to GRASS 7.0.
Can we close this ticket?
#2435: finish replacement of python api doxygen doc by sphinx
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: defect | Status: new
Priority: major | Milestone: 7.1.0
Component: Docs | Version: unspecified
Keywords: doxygen, python, sphinx | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------
Comment(by wenzeslaus):
Replying to [comment:5 lucadelu]:
> Replying to [comment:4 neteler]:
> > Luca has done a lot of cleanup. I have added a tiny intro (to be
expanded).
> >
> > All online at: http://grass.osgeo.org/grass71/manuals/libpython/
> >
> > (updated bi-weekly through a cronjob)
>
> Changeset r62706 backported all the Python Sphinx doc and removed the
dox files to GRASS 7.0.
> Can we close this ticket?
I don't think so, list in comment:3 is still valid.