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

Re-cast SWUG as Sphinx doc as pathfinder experiment

    Details

    • Type: Story
    • Status: Won't Fix
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
    • Team:
      SQuaRE

      Description

      Re-cast SWUG as a Sphinx document to explore migration to this utility for DM documentation. Describe issues with conversion, weaknesses and strengths of Sphinx as an authoring tool for user-facing documents. Full integration with the DM Stack source documentation will require a tool such as Breathe.

        Attachments

          Activity

          Hide
          shaw Richard Shaw [X] (Inactive) added a comment -

          Attached file is a rough implementation of the SWUG in Sphinx. It is perhaps 75% complete, but hyperlinks have not been fully implemented. Still, it illustrates how the SWUG would look; the rendering is not bad.

          Show
          shaw Richard Shaw [X] (Inactive) added a comment - Attached file is a rough implementation of the SWUG in Sphinx. It is perhaps 75% complete, but hyperlinks have not been fully implemented. Still, it illustrates how the SWUG would look; the rendering is not bad.
          Hide
          swinbank John Swinbank added a comment -

          I think we can regard this as obsolete given pipelines.lsst.io

          Show
          swinbank John Swinbank added a comment - I think we can regard this as obsolete given pipelines.lsst.io

            People

            • Assignee:
              shaw Richard Shaw [X] (Inactive)
              Reporter:
              shaw Richard Shaw [X] (Inactive)
              Watchers:
              Frossie Economou, John Swinbank, Richard Shaw [X] (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel