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

Stack API documentation

    Details

    • Epic Name:
      sqre-f16-doc-pipe-1
    • Story Points:
      20
    • WBS:
      1.02C.10.02
    • Team:
      SQuaRE
    • Cycle:
      Fall 2016

      Description

      Stack API Doc generation -> pipelines.lsst.io

      Deliverables:

      • a proof of concept of a CI-driven API doc build
      • documentation content planning

        Attachments

          Issue Links

            Activity

            Hide
            frossie Frossie Economou added a comment -

            Backlog epic link

            Show
            frossie Frossie Economou added a comment - Backlog epic link
            Hide
            jsick Jonathan Sick added a comment -

            meas_extensions_convolved is an ideal prototype package for demonstrating task documentation in the new Sphinx documentation.

            Show
            jsick Jonathan Sick added a comment - meas_extensions_convolved is an ideal prototype package for demonstrating task documentation in the new Sphinx documentation.
            Hide
            frossie Frossie Economou added a comment -

            I have reviewed the work done against the deliverables of this epic. This is the status:

            • Documentation content planning was delivered through the release of https://dmtn-030.lsst.io - consult that document for the details of the plan.
            • Regarding the additional deliverable of a proof-of-concept CI-driven API doc build: As part of working on the plan outlined in DMTN-030 with the pipelines team, it was decided to fully integrate the Sphinx documentation build with our scons usage. DM-8671 intended to prototype Jenkins-based pipelines.lsst.io builds using a mechanism in ltd-mason documented in https://sqr-006.lsst.io/#ltd-mason-for-multi-repository-eups-documentation-projects. Hence we are abandoning the planned ltd-mason deliverable, and building the new scons-based approach as new scope in a future epic.
            Show
            frossie Frossie Economou added a comment - I have reviewed the work done against the deliverables of this epic. This is the status: Documentation content planning was delivered through the release of https://dmtn-030.lsst.io - consult that document for the details of the plan. Regarding the additional deliverable of a proof-of-concept CI-driven API doc build: As part of working on the plan outlined in DMTN-030 with the pipelines team, it was decided to fully integrate the Sphinx documentation build with our scons usage. DM-8671 intended to prototype Jenkins-based pipelines.lsst.io builds using a mechanism in ltd-mason documented in https://sqr-006.lsst.io/#ltd-mason-for-multi-repository-eups-documentation-projects . Hence we are abandoning the planned ltd-mason deliverable, and building the new scons-based approach as new scope in a future epic.

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                frossie Frossie Economou
                Reviewers:
                Frossie Economou
                Watchers:
                Frossie Economou, Jonathan Sick
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel