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

Science Pipelines and Project Documentation Improvements

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Epic Name:
      sqre-f19-doceng-2
    • Story Points:
      40
    • WBS:
      1.02C.10.02
    • Team:
      SQuaRE
    • Cycle:
      Fall 2019

      Description

      This epic oversees infrastructure improvements to documentation builds for piplines.lsst.io and related software projects. The main goal is to integrate C++ reference documentation into pipelines.lsst.io. Secondarily this epic will address ad hoc requests to improve infrastructure for project documentation as they come up.

        Attachments

        Stories in Epic (Custom Issue Matrix)

        Key Summary Story Points Assignee Status
         
        		DM-22461

        Create Sphinx "autocppapi" extension in Documenteer

        		 3.6 Jonathan Sick Done
         
        		DM-22572

        Fix script insertion in lsst-sphinx-bootstrap-theme for Sphinx 2.0

        		 0.7 Jonathan Sick Done
         
        		DM-22524

        Port 19.0.x branch to master of pipelines_lsst_io

        		 0.4 Jonathan Sick Done
         
        		DM-22520

        Document topic support for pipeline tasks

        		 1 Jonathan Sick Done
         
        		DM-22500

        Trial generating C++ documentation for pipelines.lsst.io using "exhale"

        		 3.9 Jonathan Sick Done
         
        		DM-22499

        Trial generating C++ documentation for pipelines.lsst.io using Breathe's breathe-apidoc tool

        		 2.4 Jonathan Sick Done
         
        		DM-22537

        Update pyyaml.load usage in documenteer 0.4.x and 0.5.x

        		 0.5 Jonathan Sick Done
         
        		DM-22533

        Update documenteer with compatibility for Sphinx >= 2.0

        		 1.9 Jonathan Sick Done
         
        		DM-22698

        Run stack-wide Doxygen builds from Documenteer, replacing makeDocs and create_xlinkdocs.sh

        		 6.5 Jonathan Sick Done
         
        		DM-22717

        Add mypy-based static type checking to Documenteer

        		 1.4 Jonathan Sick Done
         
        		DM-23094

        Implement C++ reference documentation for pipelines.lsst.io using "Doxylink"

        		 6.8 Jonathan Sick Done
         
        		DM-22101

        Update form of AURA copyright statement

        		 0.4 Jonathan Sick Done
         
        		DM-22131

        Give tutorial on docs for November 2019 DM Bootcamp

        		 4.1 Jonathan Sick Done
         
        		DM-21719

        DDS packages need some extra env vars to run tests

        		 1 Jonathan Sick Done
         
        		DM-21718

        Consider eliminating the ups cfg file for a pure python package

        		 0.5 Jonathan Sick Done
         
        		DM-21708

        Drop the "example_project" project from lsst/templates

        		 0.2 Jonathan Sick Done
         
        		DM-21707

        templates CI strategy does not detect untracked files

        		 1.4 Jonathan Sick Done
         
        		DM-21791

        Update pipelines.lsst.io Getting Started tutorial because of ci_hsc split

        		 0.7 Jonathan Sick Done
         
        		DM-21842

        Fix "TSTN" series ID in technote_rst's templatekit.yaml

        		 0.2 Jonathan Sick Done
         
        		DM-20866

        Fix package-docs recursion depth error from rebuilds

        		 1.4 Jonathan Sick Done
         
        		DM-20839

        Fix version switcher for Sphinx technotes in non-main editions

        		 0.5 Jonathan Sick Done
         
        		DM-21528

        Escape quotes in Jinja variables being inserted into technote, and other, templates

        		 1.8 Jonathan Sick Done
         
        		DM-11760

        Update LTD Keeper's Cloud SQL Proxy to the latest (1.10) release

        		 1.4 Jonathan Sick Done

          Activity

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

          The main product of this epic is that documenteer, in 0.6, now performs the entire Doxygen build. We no longer require lsstDoxygen and sconsUtils to build the Doxygen C++ documentation. After evaluating multiple off-the-shelf options (including Breathe and Exhale), we found that none of those methods could yield a C++ reference that was as usable as the HTML output of Doxygen itself. Thus we now include the full Doxygen C++ reference build as a subsite of the Sphinx-based pipelines.lsst.io build. We've build an extension into Documenteer, autocppapi that lets us list and link into the C++ reference from each module homepage. With this, the C++ documentation experience is as close as possible to the Python documentation one.

          Show
          jsick Jonathan Sick added a comment - The main product of this epic is that documenteer, in 0.6, now performs the entire Doxygen build. We no longer require lsstDoxygen and sconsUtils to build the Doxygen C++ documentation. After evaluating multiple off-the-shelf options (including Breathe and Exhale), we found that none of those methods could yield a C++ reference that was as usable as the HTML output of Doxygen itself. Thus we now include the full Doxygen C++ reference build as a subsite of the Sphinx-based pipelines.lsst.io build. We've build an extension into Documenteer, autocppapi that lets us list and link into the C++ reference from each module homepage. With this, the C++ documentation experience is as close as possible to the Python documentation one.
          Hide
          Permalink
          frossie Frossie Economou added a comment -

          (oversightr, this epic should have been marked as complete last cycle as work was done on time)

          Show
          frossie Frossie Economou added a comment - (oversightr, this epic should have been marked as complete last cycle as work was done on time)

            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:

                Jenkins

                No builds found.