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

Update user guide for display_firefly

    XMLWordPrintable

    Details

    • Story Points:
      6
    • Epic Link:
    • Sprint:
      SUIT Sprint 2019-01, SUIT Sprint 2019-02
    • Team:
      Science User Interface

      Description

      The daily build of pipelines.lsst.io includes a section for lsst.display.firefly, but it is only a stub. We wrote a user guide previously in DM-10601 which at that time was hosted on a temporary site. The index.rst file needs to be moved into the right subdirectory.

      As part of DM-16782, the module documentation for lsst.display.firefly was moved to the right location to appear on pipelines.lsst.io. This ticket is to expand the user guide to document the new functionality that has been added in recent months. The user guide will contain some pages that apply to the LSST Science Platform case, and some other pages that cover our other supported use case of a user running the stack and Firefly locally on their own desktop or laptop.

      If feasible, the work in this ticket will enable automodapi, as has been done for lsst.display.ds9. This likely will require updates to docstrings.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              shupe David Shupe
              Reporter:
              shupe David Shupe
              Reviewers:
              Cindy Wang [X] (Inactive)
              Watchers:
              Cindy Wang [X] (Inactive), David Shupe, Gregory Dubois-Felsmann, Jonathan Sick, Tatiana Goldina, Trey Roby, Xiuqin Wu [X] (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.