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

Build ltd-mason for running a multi-package software documentation build

    XMLWordPrintable

    Details

      Description

      LSST the Docs (SQR-006) is a system for extending our existing Jenkins build infrastructure to build Sphinx-based software documentation for our Eups-based packages. This is a ticket to implement the ltd-mason service, which runs on Jenkins after the buildlsstsw.sh step and compiles software documentation.

      Specific outcomes of this ticket are

      • Full specification of the YAML interface between ltd-mason and buildlsstsw.sh (including creating a mock YAML file for local testing)
      • Demonstration of a Science Pipelines documentation build on a local lsstsw environment (in conjunction with content from DM-4195)
      • Accommodations to the science pipelines documentation repo and documenteer for building sphinx packages are included in this ticket’s scope.

      Next steps are

      • Standing up the service on Jenkins and testing integration with buildlsstsw.sh
      • Uploading to S3 (which involves building integration with ltd-keeper.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-4143 Demonstrate using Breathe for Python & C++ API reference in New Docs

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-4900 Generate Doxygen XML output via sconsUtils

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-4950 Build MVP of ltd-keeper web app covering ltd-mason interface

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-5457 Adapt LTD Mason for Single-package doc builds on Travis CI

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-11004 pipelines.lsst.io site build tool

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-4195 Build proof-of-concept package documentation for lsst.afw

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-5169 Fastly API interactions for LSST the Docs

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            It may be better to relocate lsstsw-based package discovery from documenteer into a local setup script for ltd-mason. This way documenteer is fully isolated from knowledge of the Stack/Eups.

            Show
            jsick Jonathan Sick added a comment - It may be better to relocate lsstsw-based package discovery from documenteer into a local setup script for ltd-mason . This way documenteer is fully isolated from knowledge of the Stack/Eups.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            This is to review the MVP of ltd-mason, the service that will live on Jenkins and run Sphinx builds. I’m hoping this review can uncover any faults in the existing code and review the plausibility of the YAML interface file between the Jenkins lsstsw builder and ltd-mason (see integrations_tests/manifest.yaml for an example). New linked tickets have been, and will be from this review, created to finalize this code for production.

            Show
            jsick Jonathan Sick added a comment - This is to review the MVP of ltd-mason, the service that will live on Jenkins and run Sphinx builds. I’m hoping this review can uncover any faults in the existing code and review the plausibility of the YAML interface file between the Jenkins lsstsw builder and ltd-mason (see integrations_tests/manifest.yaml for an example). New linked tickets have been, and will be from this review, created to finalize this code for production.
            Hide
            Permalink
            jhoblitt Joshua Hoblitt added a comment -

            I created a PR for the ltd-mason branch and have made some preliminary comments on it. The acceptance test s3upload_demo.py appears to need to be updated for API changes. I haven't yet run through the complete doc build but hope to get to this soon.

            Show
            jhoblitt Joshua Hoblitt added a comment - I created a PR for the ltd-mason branch and have made some preliminary comments on it. The acceptance test s3upload_demo.py appears to need to be updated for API changes. I haven't yet run through the complete doc build but hope to get to this soon.
            Hide
            Permalink
            jhoblitt Joshua Hoblitt added a comment -

            Review comments have been provided both on the GH PR and by "pair programming" review. Looks great!

            Show
            jhoblitt Joshua Hoblitt added a comment - Review comments have been provided both on the GH PR and by "pair programming" review. Looks great!

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              Joshua Hoblitt
              Watchers:
              Jonathan Sick, Joshua Hoblitt, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.