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

add sphinx documentation of the Click CLI in daf_butler

    XMLWordPrintable

    Details

    • Story Points:
      4
    • Sprint:
      DB_F20_09
    • Team:
      Data Access and Database
    • Urgent?:
      No

      Attachments

        Issue Links

          Activity

          Hide
          jsick Jonathan Sick added a comment -

          In DM-24411 I've added the sphinx-click to the default configuration for stack documentation projects. This means you won't need to add sphinx_click in your own conf.py file. It also means that these docs can be built by Jenkins (e.g. daily documentation builds, weekly builds, etc.).

          Show
          jsick Jonathan Sick added a comment - In DM-24411 I've added the sphinx-click to the default configuration for stack documentation projects. This means you won't need to add sphinx_click in your own conf.py file. It also means that these docs can be built by Jenkins (e.g. daily documentation builds, weekly builds, etc.).
          Hide
          npease Nate Pease [X] (Inactive) added a comment -

          Ignore the dm_dev_guide branch; it will not get checked in with this ticket.

          Show
          npease Nate Pease [X] (Inactive) added a comment - Ignore the dm_dev_guide branch; it will not get checked in with this ticket.
          Hide
          npease Nate Pease [X] (Inactive) added a comment -

          Hi Michelle, thanks for agreeing to review.

          Show
          npease Nate Pease [X] (Inactive) added a comment - Hi Michelle, thanks for agreeing to review.
          Hide
          mgower Michelle Gower added a comment -

          Some typos to fix. Merge is approved.

          An organization question about generic click framework code being in daf_butler instead of a more generic package.

          The documentation will help with writing subcommands for butler/pipetask.

          The code/option reuse is nice. For future discussion, not sure how to take advantage of this if using YAML config files instead of command line arguments.

          Show
          mgower Michelle Gower added a comment - Some typos to fix. Merge is approved. An organization question about generic click framework code being in daf_butler instead of a more generic package. The documentation will help with writing subcommands for butler/pipetask. The code/option reuse is nice. For future discussion, not sure how to take advantage of this if using YAML config files instead of command line arguments.

            People

            Assignee:
            npease Nate Pease [X] (Inactive)
            Reporter:
            npease Nate Pease [X] (Inactive)
            Reviewers:
            Michelle Gower
            Watchers:
            Jonathan Sick, Michelle Gower, Nate Pease [X] (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.