Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-28969

Cleanup lsstDebug references in Task docs

    XMLWordPrintable

Details

    • 2
    • AP S23-2 (January), AP S23-3 (February)
    • Alert Production
    • 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

          Activity

            Parejkoj John Parejko added a comment -

            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).

            Parejkoj John Parejko added a comment - 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).

            bsmart: this is still in review: were there other packages I should look at?

            Parejkoj John Parejko added a comment - bsmart : this is still in review: were there other packages I should look at?
            bsmart Brianna Smart added a comment - - edited

            Parejkoj No I just needed you to move it from in review to reviewed. I don't believe I can move it myself, or at least one other time I tried to do it myself it wouldn't let me.

             

            Actually this one will let me mark the review is complete myself. Not sure why I had other ones that wouldn't let me do the same.

            bsmart Brianna Smart added a comment - - edited Parejkoj  No I just needed you to move it from in review to reviewed. I don't believe I can move it myself, or at least one other time I tried to do it myself it wouldn't let me.   Actually this one will let me mark the review is complete myself. Not sure why I had other ones that wouldn't let me do the same.

            People

              bsmart Brianna Smart
              Parejkoj John Parejko
              John Parejko
              Brianna Smart, Eric Bellm, Ian Sullivan, John Parejko
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.