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

Documentation engineering enhancements and support

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Epic Name:
      sqre-s19-doceng-1
    • Story Points:
      30
    • WBS:
      1.02C.10.02
    • Team:
      SQuaRE
    • Cycle:
      Spring 2019

      Description

      This epic covers ongoing development of our documentation infrastructure. It includes heavily requested features such as branch builds and conda packaging for Stack documentation (pipelines.lsst.io), as well as a design kick-off for extended search functionality.

        Attachments

        Stories in Epic (Custom Issue Matrix)

        Key Summary Story Points Assignee Status
         
        		DM-17191

        Support standalone documentation sites for stack_package templates

        		 0.9 Jonathan Sick Done
         
        		DM-17155

        Remove __init__ files from generated templates

        		 0.9 Jonathan Sick Done
         
        		DM-17065

        Automatically version installation documentation for pipelines.lsst.io

        		 2.7 Jonathan Sick Done
         
        		DM-17968

        Update URL in nb.lsst.io documentation

        		 0.1 Jonathan Sick Done
         
        		DM-17927

        Lander is not skipping pull requests from forks

        		 0.7 Jonathan Sick Done
         
        		DM-17263

        Improve lsst-sphinx-bootstrap-theme for standalone package builds

        		 0.4 Jonathan Sick Done
         
        		DM-17840

        Create a Sphinx documentation site for astro_metadata_translator

        		 1 Jonathan Sick Done
         
        		DM-17827

        Update doc/ directories of packages for latest standards

        		 1 Jonathan Sick Done
         
        		DM-17765

        Make pipelines.lsst.io only include packages that are direct dependencies of the pipelines_lsst_io table file

        		 0.7 Jonathan Sick Done
         
        		DM-17661

        Fix pipelines.lsst.io build issue from 2019-01-30 #337

        		 1.4 Jonathan Sick Done
         
        		DM-16935

        Remove pyenv instructions from pipelines.lsst.io build instructions

        		 0.3 Jonathan Sick Done
         
        		DM-16905

        Install lsst-texmf into the docker image in full

        		 0.5 Jonathan Sick Done
         
        		DM-16827

        Add multiline example to Struct

        		 2.4 Jonathan Sick Done
         
        		DM-16826

        Clarify role of extended description vs. notes in developer guide

        		 1.8 Jonathan Sick Done
         
        		DM-17879

        Fix RegistryApi put/post/patch delete methods in Kafkit

        		 0.3 Jonathan Sick Done
         
        		DM-16787

        Incorrect URL in pipe_tasks documentation

        		 0.1 Jonathan Sick Done
         
        		DM-11558

        pex_config numpydoc conversion and package documentation configuration

        		 8.9 Jonathan Sick Done
         
        		DM-11462

        Create a living DM user documentation content style guide

        		 1.7 Jonathan Sick Done
         
        		DM-16911

        Check documentation rendering of module-level attributes (lsst.afw.display.BLACK)

        		 Jonathan Sick Invalid
         
        		DM-7140

        Document dependency tracking for EUPS Packages in Developer Guide

        		 Jonathan Sick Invalid

          Activity

          Hide
          Permalink
          frossie Frossie Economou added a comment -

          All work in this epic is merged to master and is in production. It includes the significant work to bring pex_config to the Sphinx-based documentation system (DM-11558) and a large number on improvements and fixes to our documentation infrastructure. 

          Show
          frossie Frossie Economou added a comment - All work in this epic is merged to master and is in production. It includes the significant work to bring pex_config to the Sphinx-based documentation system ( DM-11558 ) and a large number on improvements and fixes to our documentation infrastructure. 

            People

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

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.