Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: pipe_tasks
-
Labels:
-
Story Points:6
-
Epic Link:
-
Sprint:AP F22-3 (August), AP F22-4 (September)
-
Team:Alert Production
-
Urgent?:No
Description
The work done on DM-15554 was done at least in part on DM-35670 by Eli Rykoff. We still need to make the task topic types and automodapi links, and there may be files/methods that were missed. Unfortunately, this means that rebasing DM-15554 onto main is going to be a lot of work, so we're probably off just starting from scratch.
This ticket is to run the doxygen->numpydoc converter (attached as `deDoxygen.py` on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.
It looks like Eli Rykoff removed the docs for lsstDebug parameters, so we should pull those back in to the task topic types; it may be that the .rst files created on DM-15554 already have everything, but I'll have to check that.
Attachments
Issue Links
- duplicates
-
- Invalid
- is triggering
-
- To Do
-
- To Do
-
- To Do
-
- Done
- relates to
-
DM-25882 Update docstrings to note lsstDebug options
- To Do
-
- To Do
-
- Done
-
- Done
-
DM-14141 Automated helper for doxygen->numpydoc conversion
- To Do
-
- Done
-
DM-37165
CLONE - Cleanup lsstDebug references in Task docs
- Invalid
Activity
Jenkins run on the current version (still want to check that I didn't miss anything from DM-15554): https://ci.lsst.codes/blue/organizations/jenkins/stack-os-matrix/detail/stack-os-matrix/37289/pipeline
Erin Howard did the cleanup from my pass of the Doxygen converter I ran, I've gotten it cleaned up enough that Jenkins passed and I got a successful build of pipelines.lsst.io. I think that's enough to declare that I'm the "reviewer", and that it has been "reviewed", because asking someone to review the ~3000 lines of changes seems unreasonable.
This is still missing the Task Topic docs that Meredith Rawls added in some of the later commits on DM-15554; we should do those on another ticket, so as to get this merged. I'll file the followup tickets as triggered by this.
I'm going to say that by building a local pipelines.lsst.io and seeing that the output looks reasonable (if not always ideal), I'm going to call this reviewed, so we can merge and avoid a neverending rebase cycle.
I'm not planning to finalize the task topic types on this ticket, just get the numpy doc to build relatively cleanly. I'm also adding some text back in that was removed on
DM-35670. Better to get this merged and have something linked and be able to clean it up later, than have to try to constantly chase rebasing.