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

Add reStructuredText documentation to display_firefly

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: SUIT
    • Labels:
      None
    • Templates:
    • Story Points:
      5
    • Sprint:
      SUIT Sprint 2017-6, SUIT Sprint 2017-7, SUIT Sprint 2017-8, SUIT Sprint 2017-9, SUIT Sprint 2017-10, SUIT Sprint 2017-11
    • Team:
      Science User Interface

      Description

      Add documentation in reStructuredText format to the display_firefly package, in a doc/ subdirectory. The documentation will include setup of the afw.display interface, including the host, port, etc. parameters that are specific to display_firefly. Other points (like known issues) unique to display_firefly will be covered.

      display_firefly is not yet included with lsst_apps or lsst_distrib. Initially, an Installation section will be included. It is expected to replace the contents with links to centralized pages on how to install additional packages against a core stack installation.

      Copied for pull request https://github.com/lsst/display_firefly/pull/7

      • Add doc/_static placeholder README
      • setup initial files following validate_base as template
      • add installation, start tutorial
      • ignore eupspkg directory
      • add setup of display_firefly for Python API ref
      • add introduction, installation content
      • fill out rest of Using... section
      • Pin Sphinx<1.6.0
      • Various reStructuredText formatting fixes
      • reformat Makefile
      • Merge branch 'tickets/DM-11017' into tickets/DM-10601

        Attachments

          Container Issues

            Issue Links

              Activity

                People

                • Assignee:
                  shupe David Shupe
                  Reporter:
                  shupe David Shupe
                  Reviewers:
                  Gregory Dubois-Felsmann, Simon Krughoff
                  Watchers:
                  David Shupe, Gregory Dubois-Felsmann, Jonathan Sick, Xiuqin Wu
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  4 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Summary Panel