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

Fix doxygen errors in pipe_tasks

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: pipe_tasks
    • Labels:
      None
    • Story Points:
      4
    • Epic Link:
    • Sprint:
      AP S22-5 (April)
    • Team:
      Alert Production
    • Urgent?:
      No

      Description

      Examining the build logs for pipe_tasks demonstrated that we are still using doxygen to build the docs and there are some unexplained slow downs during that process. In particular between CharacterizeImageTask and MakeCoaddTempExpTask there is a 2 minute pause in logging on a Jenkins run:

      [2022-01-06T16:03:51.943911Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:245: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
      		 
      [2022-01-06T16:03:51.944330Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:246: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
      		 
      [2022-01-06T16:03:51.944774Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:249: warning: Found recursive @copybrief or @copydoc relation for argument 'CharacterizeImageTask'.
      		 
      [2022-01-06T16:03:51.944782Z] 
      [2022-01-06T16:03:51.945163Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:249: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
      		 
      [2022-01-06T16:03:51.945543Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:250: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
      		 
      [2022-01-06T16:05:26.867714Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:115: warning: Found recursive @copybrief or @copydoc relation for argument 'MakeCoaddTempExpTask'.
      		 
      [2022-01-06T16:05:26.867727Z] 
      [2022-01-06T16:05:26.868102Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:115: warning: unable to resolve reference to 'MakeCoaddTempExpTask_' for \ref command
      		 
      [2022-01-06T16:05:26.868478Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:116: warning: unable to resolve reference to 'MakeCoaddTempExpTask_' for \ref command
      		 
      [2022-01-06T16:05:26.868903Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:119: warning: Found recursive @copybrief or @copydoc relation for argument 'MakeCoaddTempExpTask'.
      		 
      [2022-01-06T16:05:26.868910Z]

      It's possibly that fixing the errors will fix the slow down. Ideally we would convert to sphinx but that is beyond the scope of this ticket.

      See https://ci.lsst.codes/job/stack-os-matrix/35647/artifact/macos/lsstsw/build/pipe_tasks/_build.log

        Attachments

          Activity

          Ascending order - Click to sort in descending order
          tjenness Tim Jenness created issue -
          tjenness Tim Jenness made changes -
          Field Original Value New Value
          Summary Migrate pipe_tasks documentation to sphinx Fix doxygen errors in pipe_tasks
          tjenness Tim Jenness made changes -
          Description Examining the build logs for pipe_tasks demonstrated that we are still using doxygen to build the docs and there are some unexplained slow downs during that process. In particular between CharacterizeImageTask and MakeCoaddTempExpTask there is a 2 minute pause in logging on a Jenkins run:

          {code}
          [2022-01-06T16:03:51.943911Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:245: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
          [2022-01-06T16:03:51.944330Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:246: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
          [2022-01-06T16:03:51.944774Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:249: warning: Found recursive @copybrief or @copydoc relation for argument 'CharacterizeImageTask'.
          [2022-01-06T16:03:51.944782Z]
          [2022-01-06T16:03:51.945163Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:249: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
          [2022-01-06T16:03:51.945543Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:250: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
          [2022-01-06T16:05:26.867714Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:115: warning: Found recursive @copybrief or @copydoc relation for argument 'MakeCoaddTempExpTask'.
          [2022-01-06T16:05:26.867727Z]
          [2022-01-06T16:05:26.868102Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:115: warning: unable to resolve reference to 'MakeCoaddTempExpTask_' for \ref command
          [2022-01-06T16:05:26.868478Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:116: warning: unable to resolve reference to 'MakeCoaddTempExpTask_' for \ref command
          [2022-01-06T16:05:26.868903Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:119: warning: Found recursive @copybrief or @copydoc relation for argument 'MakeCoaddTempExpTask'.
          [2022-01-06T16:05:26.868910Z]
          {code}

          Removing doxygen completely is probably the better answer rather than continuing to run doxygen.

          See https://ci.lsst.codes/job/stack-os-matrix/35647/artifact/macos/lsstsw/build/pipe_tasks/_build.log           		Examining the build logs for pipe_tasks demonstrated that we are still using doxygen to build the docs and there are some unexplained slow downs during that process. In particular between CharacterizeImageTask and MakeCoaddTempExpTask there is a 2 minute pause in logging on a Jenkins run:

          {code}
          [2022-01-06T16:03:51.943911Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:245: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
          [2022-01-06T16:03:51.944330Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:246: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
          [2022-01-06T16:03:51.944774Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:249: warning: Found recursive @copybrief or @copydoc relation for argument 'CharacterizeImageTask'.
          [2022-01-06T16:03:51.944782Z]
          [2022-01-06T16:03:51.945163Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:249: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
          [2022-01-06T16:03:51.945543Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/characterizeImage.py:250: warning: unable to resolve reference to 'CharacterizeImageTask_' for \ref command
          [2022-01-06T16:05:26.867714Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:115: warning: Found recursive @copybrief or @copydoc relation for argument 'MakeCoaddTempExpTask'.
          [2022-01-06T16:05:26.867727Z]
          [2022-01-06T16:05:26.868102Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:115: warning: unable to resolve reference to 'MakeCoaddTempExpTask_' for \ref command
          [2022-01-06T16:05:26.868478Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:116: warning: unable to resolve reference to 'MakeCoaddTempExpTask_' for \ref command
          [2022-01-06T16:05:26.868903Z] /Users/square/j/ws/stack-os-matrix/macos/lsstsw/build/pipe_tasks/python/lsst/pipe/tasks/makeCoaddTempExp.py:119: warning: Found recursive @copybrief or @copydoc relation for argument 'MakeCoaddTempExpTask'.
          [2022-01-06T16:05:26.868910Z]
          {code}

          It's possibly that fixing the errors will fix the slow down. Ideally we would convert to sphinx but that is beyond the scope of this ticket.

          See https://ci.lsst.codes/job/stack-os-matrix/35647/artifact/macos/lsstsw/build/pipe_tasks/_build.log
          krzys Krzysztof Findeisen made changes -
          Epic Link DM-30502 [ 510160 ]
          Sprint AP S22-3 (February) [ 1142 ]
          sullivan Ian Sullivan made changes -
          Sprint AP S22-3 (February) [ 1142 ] AP S22-5 (April) [ 1156 ]
          sullivan Ian Sullivan made changes -
          Rank Ranked higher
          sullivan Ian Sullivan made changes -
          Epic Link DM-30502 [ 510160 ] DM-30506 [ 510172 ]
          krzys Krzysztof Findeisen made changes -
          Rank Ranked higher
          krzys Krzysztof Findeisen made changes -
          Rank Ranked lower
          sullivan Ian Sullivan made changes -
          Rank Ranked higher
          krzys Krzysztof Findeisen made changes -
          Status To Do [ 10001 ] In Progress [ 3 ]
          krzys Krzysztof Findeisen made changes -
          Reviewers Kian-Tat Lim [ ktl ]
          Status In Progress [ 3 ] In Review [ 10004 ]
          ktl Kian-Tat Lim made changes -
          Status In Review [ 10004 ] Reviewed [ 10101 ]
          krzys Krzysztof Findeisen made changes -
          Resolution Done [ 10000 ]
          Status Reviewed [ 10101 ] Done [ 10002 ]

            People

            Assignee:
            krzys Krzysztof Findeisen
            Reporter:
            tjenness Tim Jenness
            Reviewers:
            Kian-Tat Lim
            Watchers:
            Eli Rykoff, Ian Sullivan, Kian-Tat Lim, Krzysztof Findeisen, Tim Jenness
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.