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

Enable sphinx documentation in obs_lsst

    Details

      Description

      obs_lsst needs to have the documentation build enabled. It still mostly uses doxygen strings (presumably as a hold over from the early days).

        Attachments

          Activity

          Hide
          tjenness Tim Jenness added a comment -

          Jonathan Sick would you be able to give this a quick review to make sure I've done it properly? Almost completely docstring changes and no substantive code changes here. Merlin Fisher-Levine feel free to take a look as well.

          Show
          tjenness Tim Jenness added a comment - Jonathan Sick would you be able to give this a quick review to make sure I've done it properly? Almost completely docstring changes and no substantive code changes here. Merlin Fisher-Levine feel free to take a look as well.
          Hide
          mfisherlevine Merlin Fisher-Levine added a comment -

          Some really picky comments just because you asked for them

          Looks great though, and many thanks for bring this into the present, the Doxygen format stuff really shows just how much of this was copied and pasted from the deep past!

          Show
          mfisherlevine Merlin Fisher-Levine added a comment - Some really picky comments just because you asked for them Looks great though, and many thanks for bring this into the present, the Doxygen format stuff really shows just how much of this was copied and pasted from the deep past!
          Hide
          jsick Jonathan Sick added a comment - - edited

          This looks good, within the scope.  Just a couple comments on the PR.

          One last thing you might have to do is add obs_lsst as a dependency in pipelines_lsst_iohttps://github.com/lsst/pipelines_lsst_io/blob/master/ups/pipelines_lsst_io.table

          Show
          jsick Jonathan Sick added a comment - - edited This looks good, within the scope.  Just a couple comments on the PR. One last thing you might have to do is add obs_lsst as a dependency in pipelines_lsst_io :  https://github.com/lsst/pipelines_lsst_io/blob/master/ups/pipelines_lsst_io.table
          Hide
          tjenness Tim Jenness added a comment -

          Thanks. I've modernized the doc directory (I copied from daf_butler, which was an early adopter). I can't add to pipelines.lsst.io until obs_lsst is added to lsst_distrib via RFC-569. I'll make a ticket for that.

          Show
          tjenness Tim Jenness added a comment - Thanks. I've modernized the doc directory (I copied from daf_butler, which was an early adopter). I can't add to pipelines.lsst.io until obs_lsst is added to lsst_distrib via RFC-569 . I'll make a ticket for that.

            People

            • Assignee:
              tjenness Tim Jenness
              Reporter:
              tjenness Tim Jenness
              Reviewers:
              Jonathan Sick
              Watchers:
              Colin Slater, John Swinbank, Jonathan Sick, Leanne Guy, Merlin Fisher-Levine, Robert Lupton, Tim Jenness, Wil O'Mullane
            • Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel