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

Create rst directives that build the module and package toctrees for pipelines.lsst.io

    XMLWordPrintable

    Details

      Description

      Create reStructuredText directives that build the module and package toctrees for pipelines.lsst.io.

      Building these toctrees automatically will make the pipelines_lsst_io repo more robust to a changing composition of stack packages.

      The list of modules and packages available for the documentation should generally be known from eups setups and the presence of manifest.yaml files.

      The directives should allow for packages to be explicitly ignored even if they are automatically detected. This feature should be easy to implement and will provide a safety valve for automatic package detection.

      The directives will be implemented in https://github.com/lsst-sqre/documenteer.

        Attachments

          Issue Links

            Activity

            No builds found.
            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-12790 [ 36408 ]
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Story Points 1.2
            jsick Jonathan Sick made changes -
            Story Points 1.2 2.2
            Hide
            jsick Jonathan Sick added a comment -

            New directives:

            .. module-toctree::
             
            .. package-toctree::
            

            Show
            jsick Jonathan Sick added a comment - New directives: .. module-toctree::   .. package-toctree::
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status In Progress [ 3 ] Done [ 10002 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-14773 [ DM-14773 ]

              People

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

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.