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

Add ability to exclude packages/modules from package-toctree and module-toctree

    XMLWordPrintable

    Details

      Description

      Add the ability to exclude named packages and modules from the piplines.lsst.io documentation through a "skip" field in the package-toctree and module-toctree directives.

      The "skip" field takes a comma-delimited list of names.

      This field is useful for temporarily removing packages that break the documentation build.

        Attachments

          Activity

          Ascending order - Click to sort in descending order
          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 -
          Risk Score 0
          jsick Jonathan Sick made changes -
          Story Points 1
          Hide
          Permalink
          jsick Jonathan Sick added a comment -

          Implemented in documenteer as both the s/-skip options for the stack-docs CLI and as skip options for package-toctree and module-toctree directives. The -s option with stack-docs is currently the better technical solution.

          Show
          jsick Jonathan Sick added a comment - Implemented in documenteer as both the  s/ -skip options for the stack-docs CLI and as skip options for package-toctree and module-toctree directives. The -s option with stack-docs is currently the better technical solution.
          jsick Jonathan Sick made changes -
          Resolution Done [ 10000 ]
          Status To Do [ 10001 ] Done [ 10002 ]

            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.