Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: base, meas_algorithms, meas_astrom, pipe_tasks
-
Labels:
-
Story Points:2
-
Epic Link:
-
Sprint:AP S23-2 (January), AP S23-3 (February)
-
Team:Alert Production
-
Urgent?:No
Description
Once the lsstDebug mainpage.dox page is converted to reStructuredText, we can make sure all the necessary baseDebug links are fixed in the Task Topic Types that currently exist. Depending on how DM-28968 is done, this ticket might not actually be necessary.
Attachments
Issue Links
- is blocked by
-
DM-28968 Convert lsstDebug doxygen doc to restructuredText
- Invalid
Turns out I lied when we chatted: lsstDebug is available from the root of the doc tree.
https://pipelines.lsst.io/modules/lsstDebug/index.html
So, you should be able to link to it directly with :ref:`lsstDebug`. An example is `lsst.meas.astrom.AstrometryTask.rst` in the meas_astrom docs. The Debugging section there should use that `:ref:` syntax, instead of just backticks around lsstDebug. We'll probably want to cleanup those docs a bit more as part of this (e.g. wrap the --debug note at the bottom in double-backticks).