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
    • 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

          Issue Links

            Activity

            Hide
            shupe David Shupe added a comment -

            Jonathan Sick I have a first draft of content pushed to the ticket branch. If it were hooked up to display_firefly.lsst.io, would people be able to review it as a version there?

            Also, I left out references to lsst.display.firefly and lsst.afw.display in the Python API section because the doc build fails. I think this means the docstrings need a lot of work.

            Show
            shupe David Shupe added a comment - Jonathan Sick I have a first draft of content pushed to the ticket branch. If it were hooked up to display_firefly.lsst.io, would people be able to review it as a version there? Also, I left out references to lsst.display.firefly and lsst.afw.display in the Python API section because the doc build fails. I think this means the docstrings need a lot of work.
            Hide
            jsick Jonathan Sick added a comment -

            David Shupe, okay I'll see if I can build the docs myself and deploy them.

            Show
            jsick Jonathan Sick added a comment - David Shupe , okay I'll see if I can build the docs myself and deploy them.
            Hide
            jsick Jonathan Sick added a comment -

            I've pushed the documentation build to https://display-firefly.lsst.io

            I've confirmed that there are issues with the API documentation that'll need a bit more work to sort out, though it seems that the published user guide is mostly what's needed right now.

            I'll push/suggest some formatting fixes through my DM-11017 branch.

            Show
            jsick Jonathan Sick added a comment - I've pushed the documentation build to https://display-firefly.lsst.io I've confirmed that there are issues with the API documentation that'll need a bit more work to sort out, though it seems that the published user guide is mostly what's needed right now. I'll push/suggest some formatting fixes through my DM-11017 branch.
            Hide
            shupe David Shupe added a comment -

            A preliminary review would be very helpful at this point. No doubt changes will be needed. One question is whether screenshots at various points would be helpful.

            Show
            shupe David Shupe added a comment - A preliminary review would be very helpful at this point. No doubt changes will be needed. One question is whether screenshots at various points would be helpful.
            Hide
            shupe David Shupe added a comment -

            Reviewed on Github by Simon Krughoff

            Show
            shupe David Shupe added a comment - Reviewed on Github by Simon Krughoff
            Hide
            shupe David Shupe added a comment -

            Jonathan Sick I know that display-firefly.lsst.io is a temporary site, until the infrastructure is ready for packages at pipelines.lsst.io. The Travis link at display-firefly.lsst.io/v/ states that the repo is inactive. Is there a way to publish the updated docs on master?

            Show
            shupe David Shupe added a comment - Jonathan Sick I know that display-firefly.lsst.io is a temporary site, until the infrastructure is ready for packages at pipelines.lsst.io. The Travis link at display-firefly.lsst.io/v/ states that the repo is inactive. Is there a way to publish the updated docs on master?
            Hide
            jsick Jonathan Sick added a comment -

            Should be uploaded to https://display-firefly.lsst.io now. (It isn't built via Travis because it requires the stack to be set up).

            Show
            jsick Jonathan Sick added a comment - Should be uploaded to https://display-firefly.lsst.io now. (It isn't built via Travis because it requires the stack to be set up).
            Hide
            shupe David Shupe added a comment -

            The update is visible on display-firefly.lsst.io

            Show
            shupe David Shupe added a comment - The update is visible on display-firefly.lsst.io

              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 [X] (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel