Opened 10 years ago
Last modified 5 years ago
#2435 reopened enhancement
finish replacement of python api doxygen doc by sphinx
| Reported by: | martinl | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | 7.8.3 |
| Component: | Docs | Version: | unspecified |
| Keywords: | doxygen, python, sphinx | Cc: | |
| CPU: | Unspecified | Platform: | Unspecified |
Description
Some content removed in r62097 is still waiting for Sphinx integration, namely:
- source:grass/trunk/gui/wxpython/wxguitoolboxes.dox@57001
- 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
Change History (20)
comment:1 by , 10 years ago
follow-up: 3 comment:2 by , 10 years ago
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:
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
comment:3 by , 10 years ago
Replying to 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:
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:
follow-up: 5 comment:4 by , 10 years ago
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)
follow-up: 6 comment:5 by , 10 years ago
Replying to 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?
comment:6 by , 10 years ago
Replying to lucadelu:
Replying to 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.
comment:10 by , 8 years ago
| Milestone: | 7.2.1 → 7.2.2 |
|---|
comment:12 by , 7 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
No activity almost 3 years. Python libraries are documented in Sphinx. Closing, feel free to reopen if needed.
comment:13 by , 7 years ago
| Resolution: | fixed |
|---|---|
| Status: | closed → reopened |
There is still some text which was not transfered, e.g. 200 lines about grass.pydispatch, see comment:3 or source:grass/trunk/lib/python/pydispatch/pydispatchlib.dox@55394.
comment:15 by , 7 years ago
| Milestone: | → 7.2.4 |
|---|
comment:16 by , 6 years ago
| Milestone: | 7.2.4 → 7.8.0 |
|---|---|
| Priority: | major → normal |
| Type: | defect → enhancement |
comment:20 by , 5 years ago
| Milestone: | → 7.8.3 |
|---|
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 mvand 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: ...