XMLWordPrintable

#### Details

• Type: Story
• Status: Done
• Resolution: Done
• Fix Version/s: None
• Component/s:
• Labels:
• Story Points:
6
• Sprint:
AP F22-3 (August), AP F22-4 (September)
• Team:
• 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.

#### Activity

No builds found.
John Parejko created issue -
Field Original Value New Value
Link This issue is triggered by DM-15554 [ DM-15554 ]
 Link This issue relates to DM-14141 [ DM-14141 ]
 Description The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. 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 on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly. The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. 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 on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.
 Description The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. 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 on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly. The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. 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.
 Description The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. 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. The work done on DM-15554 was done at least in part on DM-35670 by [~erykoff]. 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 [~erykoff] 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.
 Link This issue relates to DM-35940 [ DM-35940 ]
 Labels ap-training
 Sprint AP F22-3 (August) [ 1176 ]
 Rank Ranked higher
 Status To Do [ 10001 ] In Progress [ 3 ]
 Link This issue is triggered by DM-15554 [ DM-15554 ]
 Link This issue duplicates DM-15554 [ DM-15554 ]
 Story Points 6
 Epic Link DM-34930 [ 1598461 ]
 Sprint AP F22-3 (August) [ 1176 ] AP F22-3 (August), AP F22-4 (September) [ 1176, 1186 ]
 Link This issue is triggering DM-36182 [ DM-36182 ]
 Link This issue relates to DM-28969 [ DM-28969 ]
Hide
John Parejko added a comment -

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.

Show
John Parejko added a comment - 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.
 Link This issue relates to DM-35670 [ DM-35670 ]
Hide
John Parejko added a comment -

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

Show
John Parejko added a comment - 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
 Link This issue relates to DM-25882 [ DM-25882 ]
Hide
John Parejko added a comment -

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.

Show
John Parejko added a comment - 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.
 Reviewers John Parejko [ parejkoj ] Status In Progress [ 3 ] In Review [ 10004 ]
 Link This issue is triggering DM-36249 [ DM-36249 ]
Hide
John Parejko added a comment -

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.

Show
John Parejko added a comment - 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.
 Status In Review [ 10004 ] Reviewed [ 10101 ]
 Resolution Done [ 10000 ] Status Reviewed [ 10101 ] Done [ 10002 ]
 Link This issue is triggering DM-36250 [ DM-36250 ]
 Link This issue is triggering DM-36251 [ DM-36251 ]
 Epic Link DM-34930 [ 1598461 ] DM-36008 [ 1997424 ]
 Link This issue relates to DM-37165 [ DM-37165 ]
 Epic Link DM-36008 [ 1997424 ] DM-36006 [ 1997396 ]
 Link This issue relates to DM-37673 [ DM-37673 ]

#### People

Assignee:
Erin Howard
Reporter:
John Parejko
Reviewers:
John Parejko
Watchers:
Eric Bellm, Ian Sullivan, John Parejko, Yusra AlSayyad