# Convert pipe_tasks to numpydoc and task topics

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

John Parejko created issue -
John Parejko made changes -
Field Original Value New Value
Link This issue is triggered by DM-15554 [ DM-15554 ]
John Parejko made changes -
 Link This issue relates to DM-14141 [ DM-14141 ]
John Parejko made changes -
 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.
John Parejko made changes -
 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.
John Parejko made changes -
 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.
John Parejko made changes -
 Link This issue relates to DM-35940 [ DM-35940 ]
Ian Sullivan made changes -
 Labels ap-training
Ian Sullivan made changes -
 Sprint AP F22-3 (August) [ 1176 ]
Ian Sullivan made changes -
 Rank Ranked higher
Erin Howard made changes -
 Status To Do [ 10001 ] In Progress [ 3 ]
Ian Sullivan made changes -
 Link This issue is triggered by DM-15554 [ DM-15554 ]
Ian Sullivan made changes -
 Link This issue duplicates DM-15554 [ DM-15554 ]
Ian Sullivan made changes -
 Story Points 6
Ian Sullivan made changes -
 Epic Link DM-34930 [ 1598461 ]
Ian Sullivan made changes -
 Sprint AP F22-3 (August) [ 1176 ] AP F22-3 (August), AP F22-4 (September) [ 1176, 1186 ]
John Parejko made changes -
 Link This issue is triggering DM-36182 [ DM-36182 ]
John Parejko made changes -
 Link This issue relates to DM-28969 [ DM-28969 ]
John Parejko made changes -
 Link This issue relates to DM-35670 [ DM-35670 ]
John Parejko made changes -
 Link This issue relates to DM-25882 [ DM-25882 ]
John Parejko made changes -
 Reviewers John Parejko [ parejkoj ] Status In Progress [ 3 ] In Review [ 10004 ]
John Parejko made changes -
 Link This issue is triggering DM-36249 [ DM-36249 ]
John Parejko made changes -
 Status In Review [ 10004 ] Reviewed [ 10101 ]
John Parejko made changes -
 Resolution Done [ 10000 ] Status Reviewed [ 10101 ] Done [ 10002 ]
John Parejko made changes -
 Link This issue is triggering DM-36250 [ DM-36250 ]
John Parejko made changes -
 Link This issue is triggering DM-36251 [ DM-36251 ]
Ian Sullivan made changes -
 Epic Link DM-34930 [ 1598461 ] DM-36008 [ 1997424 ]
Ian Sullivan made changes -
 Link This issue relates to DM-37165 [ DM-37165 ]
Ian Sullivan made changes -
 Epic Link DM-36008 [ 1997424 ] DM-36006 [ 1997396 ]
John Parejko made changes -
 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