Fix Version/s: None
Sprint:AP F20-6 (November), AP S21-1 (December)
Convert all Doxygen-formatted docstrings in afw.detection to Numpydoc style, and move corresponding topic documentation to doc/.
- is blocked by
DM-16863 Convert afw.table to numpydoc
Turns out the documentation wasn't actually being displayed. Re-opening.
Documentation cannot currently be built; I think the errors will go away once afw.table is numpydoc-compatible.
Ian Sullivan, Eric Bellm, Krzysztof Findeisen Looks like this ticket has evolved from the original description. What needs to be done now?
The Sphinx documentation for lsst.afw.detection still isn't activated (see https://pipelines.lsst.io/v/daily/modules/lsst.afw.detection/index.html, which doesn't have any of the Python API). The topic page is also still in Doxygen (https://github.com/lsst/afw/blob/master/doc/mainpage.dox#L284).
In addition, while the Python docstrings have been converted from Doxygen-style (https://github.com/lsst/afw/blob/master/python/lsst/afw/detection/multiband.py), some of them can't really be called Numpydoc-style (https://github.com/lsst/afw/blob/master/python/lsst/afw/detection/_footprintMerge.py).
So I think the original description still stands.
Krzysztof, are you free to review these changes for
DM-16857? A pull request is in and the Jenkins run is here:
Looks much better, though the topic page for detection is still inside Doxygen. I give an example of how it could be moved to Sphinx, though I think this particular page could simply be deleted with no loss of information. Happy to re-review once either is done.
Did a final build check (passed) and merged to master just now. That should do the trick.
afw.detection has already been converted.